Merge pull request #351 from smartlyio/VULCAN-4165

Support `on: push` to simplify workflows

.github/workflows/check_release_label.yml

@@ -17,4 +17,3 @@ jobs:
     - uses: smartlyio/check-versioning-action@v5
       with:
         GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
-

.github/workflows/release.yml → .github/workflows/master_push.yml

@@ -1,16 +1,13 @@
-name: Build and release the action
+name: Master Push
 
-# smartlyio/find-changes-action@v1 (under Release flow) only works on pull_request events is the reason for not using "on: push: branches: master"
 on:
-  pull_request:
-    branches: [master]
-    types: [closed]
+  push:
+    branches:
+      - master
 
 jobs:
   build:
     name: Build
-    # Only run when PR is closed AND merged, not when PR is just closed.
-    if: github.event.pull_request.merged
     uses: ./.github/workflows/build.yml
     secrets: inherit
 

.github/workflows/pull_request.yml

@@ -1,8 +1,6 @@
 name: "Pull Request"
 
-on:
-  pull_request:
-    branches: [master]
+on: pull_request
 
 jobs:
   build:

__tests__/main.test.ts

@@ -39,76 +39,55 @@ afterEach(() => {
 describe('get branch point', () => {
   test('missing GITHUB_EVENT_NAME', async () => {
     delete process.env['GITHUB_EVENT_NAME']
-    const context: Context = {
-      fromOriginalBranchPoint: false,
-      directoryContaining: null, // Not used by getChangedDirectories
-      directoryLevels: null,
-      exclude: /^\.github\/.*/ // Not used by getChangedDirectories
-    }
-    await expect(getBranchPoint(context)).rejects.toThrow(
-      /only works on pull_request/
-    )
+    await expect(getBranchPoint()).rejects.toThrow(/only works on pull_request/)
   })
 
   test('wrong GITHUB_EVENT_NAME', async () => {
-    process.env['GITHUB_EVENT_NAME'] = 'push'
-    const context: Context = {
-      fromOriginalBranchPoint: false,
-      directoryContaining: null, // Not used by getChangedDirectories
-      directoryLevels: null,
-      exclude: /^\.github\/.*/ // Not used by getChangedDirectories
-    }
-    await expect(getBranchPoint(context)).rejects.toThrow(
-      /only works on pull_request/
-    )
+    process.env['GITHUB_EVENT_NAME'] = 'schedule'
+
+    await expect(getBranchPoint()).rejects.toThrow(/only works on pull_request/)
   })
 
   test('missing GITHUB_EVENT_PATH', async () => {
     process.env['GITHUB_EVENT_NAME'] = 'pull_request'
     delete process.env['GITHUB_EVENT_PATH']
-    const context: Context = {
-      fromOriginalBranchPoint: false,
-      directoryContaining: null, // Not used by getChangedDirectories
-      directoryLevels: null,
-      exclude: /^\.github\/.*/ // Not used by getChangedDirectories
-    }
-    await expect(getBranchPoint(context)).rejects.toThrow(
+    await expect(getBranchPoint()).rejects.toThrow(
       /Could not find event payload/
     )
   })
 
+  test('pull request event type closed', async () => {
+    const eventPath = path.join(__dirname, 'pr_event_closed.json')
+    const eventData = await fsReal.readFile(eventPath)
+    const event = JSON.parse(eventData.toString())
+    process.env['GITHUB_EVENT_NAME'] = 'pull_request'
+    process.env['GITHUB_EVENT_PATH'] = eventPath
+
+    await expect(getBranchPoint()).rejects.toThrow(
+      /Running find-changes on: pull_request: closed is not supported in v2 - please migrate workflow to on: push:/
+    )
+  })
+
   test('get sha of main merged to PR', async () => {
     const eventPath = path.join(__dirname, 'pr_event.json')
     const eventData = await fsReal.readFile(eventPath)
     const event = JSON.parse(eventData.toString())
     process.env['GITHUB_EVENT_NAME'] = 'pull_request'
     process.env['GITHUB_EVENT_PATH'] = eventPath
 
-    const context: Context = {
-      fromOriginalBranchPoint: false,
-      directoryContaining: null, // Not used by getChangedDirectories
-      directoryLevels: null,
-      exclude: /^\.github\/.*/ // Not used by getChangedDirectories
-    }
-    const branchPoint = await getBranchPoint(context)
+    const branchPoint = await getBranchPoint()
     expect(branchPoint).toEqual('origin/master')
   })
 
-  test('from original branch point', async () => {
-    const eventPath = path.join(__dirname, 'pr_event.json')
+  test('on push', async () => {
+    const eventPath = path.join(__dirname, 'push_event.json')
     const eventData = await fsReal.readFile(eventPath)
     const event = JSON.parse(eventData.toString())
-    process.env['GITHUB_EVENT_NAME'] = 'pull_request'
+    process.env['GITHUB_EVENT_NAME'] = 'push'
     process.env['GITHUB_EVENT_PATH'] = eventPath
 
-    const context: Context = {
-      fromOriginalBranchPoint: true,
-      directoryContaining: null, // Not used by getChangedDirectories
-      directoryLevels: null,
-      exclude: /^\.github\/.*/ // Not used by getChangedDirectories
-    }
-    const branchPoint = await getBranchPoint(context)
-    expect(branchPoint).toEqual(event.pull_request.base.sha)
+    const branchPoint = await getBranchPoint()
+    expect(branchPoint).toEqual(event.before)
   })
 })
 
@@ -129,7 +108,6 @@ deeply/nested/package/README
 top-level-file
 `
     const context: Context = {
-      fromOriginalBranchPoint: false,
       directoryContaining: null, // Not used by getChangedDirectories
       directoryLevels: null,
       exclude: /^\.github\/.*/ // Not used by getChangedDirectories
@@ -161,7 +139,6 @@ deeply/nested/package/README
 top-level-file
 `
     const context: Context = {
-      fromOriginalBranchPoint: false,
       directoryContaining: null,
       directoryLevels: 1,
       exclude: /^\.github\/.*/ // Not used by getChangedDirectories
@@ -193,7 +170,6 @@ deeply/nested/package/README
 top-level-file
 `
     const context: Context = {
-      fromOriginalBranchPoint: false,
       directoryContaining: null,
       directoryLevels: 2,
       exclude: /^\.github\/.*/ // Not used by getChangedDirectories
@@ -228,7 +204,6 @@ deeply/nested/package/README
 top-level-file
 `
     const context: Context = {
-      fromOriginalBranchPoint: false,
       directoryContaining: null, // Not used by getChangedDirectories
       directoryLevels: null,
       exclude: /^\.github\/.*/ // Not used by getChangedDirectories
@@ -289,7 +264,6 @@ describe('filterGitOutputByFile', () => {
     ]
     const expected = ['package1', 'package2', 'nested', 'deeply']
     const context: Context = {
-      fromOriginalBranchPoint: false,
       directoryContaining: null,
       directoryLevels: null,
       exclude: /^\.github($|\/.*)/
@@ -307,7 +281,6 @@ describe('filterGitOutputByFile', () => {
     ]
     const expected = ['nested/package', 'deeply/nested']
     const context: Context = {
-      fromOriginalBranchPoint: false,
       directoryContaining: null,
       directoryLevels: null,
       exclude: /^\.github($|\/.*)/
@@ -321,7 +294,6 @@ describe('filterGitOutputByFile', () => {
     const changedDirectories = ['__tests__', 'deeply/nested', '.github/actions']
     const expected = ['__tests__']
     const context: Context = {
-      fromOriginalBranchPoint: false,
       directoryContaining: 'pr_event.json',
       directoryLevels: null,
       exclude: /^\.github($|\/.*)/

__tests__/pr_event_closed.json

@@ -0,0 +1,12 @@
+{
+    "repository": {
+      "default_branch": "master"
+    },
+    "action": "closed",
+    "pull_request": {
+      "base": {
+        "sha": "pull_request_sha"
+      }
+    }
+  }
+

__tests__/push_event.json

@@ -0,0 +1,8 @@
+{
+    "repository": {
+      "default_branch": "master"
+    },
+    "action": "closed",
+    "before": "push_sha"
+  }
+

action.yml

@@ -2,14 +2,6 @@ name: 'Find changed directories'
 description: 'Create matrix expression to build only changed packages'
 author: 'Smartly.io'
 inputs:
-  from-original-branch-point:
-    description: >-
-      Find the changes from the original branch point.
-
-      The default is to find changes relative to the *current* main
-      branch, after merging the main branch into this PR.
-    required: false
-    default: false
   directory_containing:
     description: >-
       Find changes to directories containing a file with this name.