Include khan packages to make independent (#2)

Final touches to create this action

Author: nedredmond

.changeset/cyan-insects-whisper.md

@@ -0,0 +1,5 @@
+---
+'mock-workspace': patch
+---
+
+Just testing the action!

.github/linters/.markdown-lint.yml

@@ -52,15 +52,3 @@ jobs:
       - name: Test Local Action
         id: test-action
         uses: ./
-        with:
-          changed_files: '[]'
-
-      - name: Print Success
-        if: success()
-        id: success
-        run: echo "Success"
-
-      - name: Print Failure
-        if: failure()
-        id: failure
-        run: echo "Failure"

.github/workflows/ci.yml

@@ -43,3 +43,4 @@ jobs:
           TYPESCRIPT_DEFAULT_STYLE: prettier
           VALIDATE_JSCPD: false
           VALIDATE_NATURAL_LANGUAGE: false
+          VALIDATE_MARKDOWN: false

.github/workflows/linter.yml

@@ -31,6 +31,7 @@ const inputMock = jest
     }
   })
 
+jest.spyOn(exec, 'exec').mockImplementation(async () => 0)
 const getExecOutputMock = jest.spyOn(exec, 'getExecOutput')
 
 const originalContext = github.context
@@ -119,6 +120,58 @@ describe('action', () => {
     )
   })
 
+  it('fails when there are packages that need changeset entries', async () => {
+    // Arrange
+    Object.defineProperty(github, 'context', {
+      value: {
+        ...originalContext,
+        eventName: 'pull_request',
+        payload: {
+          pull_request: {
+            head: {
+              sha: '1234567890'
+            },
+            base: {
+              ref: 'main'
+            }
+          }
+        }
+      }
+    })
+    getExecOutputMock
+      // workspaces info
+      .mockImplementationOnce(async () => ({
+        stdout: JSON.stringify({
+          type: 'log',
+          data: JSON.stringify({
+            '@owner/pkg1': {
+              location: './packages/pkg1'
+            },
+            '@owner/pkgB': {
+              location: './packages/pkgB'
+            }
+          })
+        }),
+        stderr: '',
+        exitCode: 0
+      }))
+      // changeset info
+      .mockImplementationOnce(async () => ({
+        stdout: '',
+        stderr: '',
+        exitCode: 1
+      }))
+
+    // Act
+    await main.run()
+
+    // Assert
+    expect(runMock).toHaveReturned()
+    expect(setFailedMock).toHaveBeenCalledWith(
+      'Changeset entry required for @owner/pkg1, @owner/pkgB because there have been changes since the last release.'
+    )
+  })
+
   it('skips without failure when there are no changed files', async () => {
     // Arrange
     inputMock.mockImplementationOnce(() => JSON.stringify([]))
@@ -205,56 +258,6 @@ describe('action', () => {
     expect(infoMock).toHaveBeenCalledWith('No packages to verify. Skipping.')
   })
 
-  it('fails when changeset CLI call fails', async () => {
-    // Arrange
-    Object.defineProperty(github, 'context', {
-      value: {
-        ...originalContext,
-        eventName: 'pull_request',
-        payload: {
-          pull_request: {
-            head: {
-              sha: '1234567890'
-            },
-            base: {
-              ref: 'main'
-            }
-          }
-        }
-      }
-    })
-    getExecOutputMock
-      // workspaces info
-      .mockImplementationOnce(async () => ({
-        stdout: JSON.stringify({
-          type: 'log',
-          data: JSON.stringify({
-            '@owner/pkg1': {
-              location: './packages/pkg1'
-            },
-            '@owner/pkgB': {
-              location: './packages/pkgB'
-            }
-          })
-        }),
-        stderr: '',
-        exitCode: 0
-      }))
-      // changeset info
-      .mockImplementationOnce(async () => ({
-        stdout: '',
-        stderr: 'Oopsie!',
-        exitCode: 1
-      }))
-
-    // Act
-    await main.run()
-
-    // Assert
-    expect(runMock).toHaveReturned()
-    expect(setFailedMock).toHaveBeenCalledWith('Oopsie!')
-  })
-
   it('fails when workspaces CLI call fails', async () => {
     // Arrange
     Object.defineProperty(github, 'context', {
@@ -286,7 +289,7 @@ describe('action', () => {
 
     // Assert
     expect(runMock).toHaveReturned()
-    expect(setFailedMock).toHaveBeenCalledWith('Oopsie!')
+    expect(setFailedMock).toHaveBeenCalled()
   })
 
   it('fails when there is no base ref', async () => {

__tests__/main.test.ts

@@ -3,17 +3,48 @@ description: 'Fail if there is not a valid changeset entry for each package.'
 author: 'Ned Redmond'
 
 inputs:
-  changed_files:
-    description: JSON list of changed files
-    required: true
+  exclude_files_and_dirs:
+    description:
+      list of comma-separated paths (files or directories ending in /) that
+      don't need a changeset when changed. Default .github/
+    required: false
+    default: .github/
+  exclude_extensions:
+    description:
+      a list of comma-separated extensions that don't need a changeset when
+      changed. Default <empty>
+    required: false
+    default: ''
+  exclude_globs:
+    description:
+      a list of comma-separated globs (using picomatch syntax) that don't need a
+      changeset when changed. Default <empty>
+    required: false
+    default: ''
 
 runs:
   using: 'composite'
   steps:
     - name: Checkout repository
       uses: actions/checkout@v4
+      with:
+        fetch-depth: 0
+
+    - name: Get changed files
+      uses: Khan/actions@get-changed-files-v1
+      id: changed
+
+    - name: Filter out files that don't need a changeset
+      uses: Khan/actions@filter-files-v0
+      id: match
+      with:
+        changed-files: ${{ steps.changed.outputs.files }}
+        invert: true
+        files: ${{ inputs.exclude_files_and_dirs }}
+        extensions: ${{ inputs.exclude_extensions }}
+        globs: ${{ inputs.exclude_globs }}
 
     - name: Veryify changeset entries
       uses: ./actions/verify-per-package
       with:
-        changed_files: ${{ inputs.changed_files }}
+        changed_files: ${{ steps.match.outputs.filtered }}

action.yml

@@ -10916,9 +10916,6 @@ async function run() {
         // relies on the repo having yarn...
         //   a future enhancement would be to determine the package manager and use that
         const workspacesResult = await exec.getExecOutput(`yarn workspaces --json info`);
-        if (workspacesResult.exitCode !== 0) {
-            core.setFailed(workspacesResult.stderr);
-        }
         const workspacesInfo = JSON.parse(JSON.parse(workspacesResult.stdout).data);
         const workspaces = Object.keys(workspacesInfo).map(name => ({
             name,
@@ -10954,22 +10951,23 @@ async function run() {
         }
         // right now, the only way to access JSON output is to create a file,
         //   so we are just going to work with the pretty-printed output
-        const changesetResult = await exec.getExecOutput(`yarn changeset status --since ${base}`);
-        if (changesetResult.exitCode !== 0) {
-            core.setFailed(changesetResult.stderr);
-        }
-        if (!changesetResult.stdout) {
-            core.setFailed(`Changeset entries are required for the following packages: ${packageNamesArray.join(', ')}`);
+        await exec.exec(`yarn add @changesets/cli@latest -W`);
+        const changesetResult = await exec.getExecOutput(`yarn changeset status --since origin/${base}`, undefined, { ignoreReturnCode: true });
+        if (changesetResult.exitCode === 1) {
+            core.debug(`Changeset status failed; that could mean there is no changeset file, or that there was an error.`);
         }
         // parse out the package names from the pretty-printed changeset output
-        const changesetEntries = changesetResult.stdout
-            .split('\n')
-            .map((line) => line.trim())
-            .filter((line) => line.startsWith('🦋  - '))
-            .map((line) => line.replace('🦋  - ', ''));
+        const changesetEntries = changesetResult.exitCode === 1
+            ? []
+            : changesetResult.stdout
+                .split('\n')
+                .map((line) => line.trim())
+                .filter((line) => line.startsWith('🦋  - '))
+                .map((line) => line.replace('🦋  - ', ''));
         const changesetEntriesNeeded = packageNamesArray.filter(packageName => !changesetEntries.includes(packageName));
         if (changesetEntriesNeeded.length) {
             core.setFailed(`Changeset entry required for ${changesetEntriesNeeded.join(', ')} because there have been changes since the last release.`);
+            return;
         }
         core.info('All packages have changeset entries');
     }

actions/verify-per-package/dist/index.js

@@ -0,0 +1,5 @@
+{
+  "name": "mock-workspace",
+  "version": "1.0.0",
+  "description": "Just here for workflow test. See `.github/workflows/ci.yml`"
+}

mock-workspace/package.json

@@ -29,7 +29,7 @@
     "format:write": "prettier --write **/*.ts",
     "format:check": "prettier --check **/*.ts",
     "lint": "npx eslint . -c ./.github/linters/.eslintrc.yml",
-    "package": "ncc build src/index.ts --out sub-actions/verify-per-package/dist --license licenses.txt",
+    "package": "ncc build src/index.ts -o actions/verify-per-package/dist --license licenses.txt",
     "package:watch": "yarn package -- --watch",
     "test": "(jest && make-coverage-badge --output-path ./badges/coverage.svg) || make-coverage-badge --output-path ./badges/coverage.svg",
     "all": "yarn format:write && yarn lint && yarn test && yarn package"
@@ -88,5 +88,8 @@
     "prettier-eslint": "^15.0.1",
     "ts-jest": "^29.1.1",
     "typescript": "^5.2.2"
-  }
+  },
+  "workspaces": [
+    "mock-workspace"
+  ]
 }

package.json

@@ -35,10 +35,6 @@ export async function run(): Promise<void> {
       `yarn workspaces --json info`
     )
 
-    if (workspacesResult.exitCode !== 0) {
-      core.setFailed(workspacesResult.stderr)
-    }
-
     const workspacesInfo = JSON.parse(JSON.parse(workspacesResult.stdout).data)
     const workspaces = Object.keys(workspacesInfo).map(name => ({
       name,
@@ -81,27 +77,28 @@ export async function run(): Promise<void> {
 
     // right now, the only way to access JSON output is to create a file,
     //   so we are just going to work with the pretty-printed output
+    await exec.exec(`yarn add @changesets/cli@latest -W`)
     const changesetResult = await exec.getExecOutput(
-      `yarn changeset status --since ${base}`
+      `yarn changeset status --since origin/${base}`,
+      undefined,
+      { ignoreReturnCode: true }
     )
 
-    if (changesetResult.exitCode !== 0) {
-      core.setFailed(changesetResult.stderr)
-    }
-    if (!changesetResult.stdout) {
-      core.setFailed(
-        `Changeset entries are required for the following packages: ${packageNamesArray.join(
-          ', '
-        )}`
+    if (changesetResult.exitCode === 1) {
+      core.debug(
+        `Changeset status failed; that could mean there is no changeset file, or that there was an error.`
       )
     }
 
     // parse out the package names from the pretty-printed changeset output
-    const changesetEntries = changesetResult.stdout
-      .split('\n')
-      .map((line: string) => line.trim())
-      .filter((line: string) => line.startsWith('🦋  - '))
-      .map((line: string) => line.replace('🦋  - ', ''))
+    const changesetEntries =
+      changesetResult.exitCode === 1
+        ? []
+        : changesetResult.stdout
+            .split('\n')
+            .map((line: string) => line.trim())
+            .filter((line: string) => line.startsWith('🦋  - '))
+            .map((line: string) => line.replace('🦋  - ', ''))
 
     const changesetEntriesNeeded = packageNamesArray.filter(
       packageName => !changesetEntries.includes(packageName)
@@ -113,6 +110,7 @@ export async function run(): Promise<void> {
           ', '
         )} because there have been changes since the last release.`
       )
+      return
     }
 
     core.info('All packages have changeset entries')