feat: add support for include/exclude all nested files when a directory is specified and ends with a slash (#1873)

Co-authored-by: GitHub Action <action@github.com>

HISTORY.md

@@ -1,5 +1,34 @@
 # Changelog
 
+# [41.1.2](https://github.com/tj-actions/changed-files/compare/v41.1.1...v41.1.2) - (2024-01-17)
+
+## <!-- 0 -->🚀 Features
+
+- Enhance error handling and working directory resolution ([#1859](https://github.com/tj-actions/changed-files/issues/1859)) ([a60bf37](https://github.com/tj-actions/changed-files/commit/a60bf3759e069549b60c8da1284ec83e0398a1a4))  - (Tonye Jack)
+
+## <!-- 1 -->🐛 Bug Fixes
+
+- Bug with incorrect action path ([#1866](https://github.com/tj-actions/changed-files/issues/1866)) ([3f81899](https://github.com/tj-actions/changed-files/commit/3f8189989ba6fd9b3b9593ffe650236b3f1fcb55))  - (Tonye Jack)
+
+## <!-- 7 -->⚙️ Miscellaneous Tasks
+
+- **deps:** Update dependency @types/node to v20.11.5 ([cbda684](https://github.com/tj-actions/changed-files/commit/cbda684547adc8c052d50711417fa61b428a9f88))  - (renovate[bot])
+- **deps:** Update dependency prettier to v3.2.3 ([67a1f54](https://github.com/tj-actions/changed-files/commit/67a1f54f6f5ec7ee87c57eb7876a7d6dfdcc59a1))  - (renovate[bot])
+- **deps:** Update tj-actions/eslint-changed-files action to v22 ([#1864](https://github.com/tj-actions/changed-files/issues/1864)) ([99248a4](https://github.com/tj-actions/changed-files/commit/99248a443855d73284abf52520f897dba851b914))  - (renovate[bot])
+- **deps:** Update dependency @types/node to v20.11.4 ([8787431](https://github.com/tj-actions/changed-files/commit/878743189ba0ba42d467a736923b07102f0e348c))  - (renovate[bot])
+- **deps:** Update dependency @types/node to v20.11.3 ([98d1d84](https://github.com/tj-actions/changed-files/commit/98d1d84e2f7a404c425df4e44dceb74a03920ac8))  - (renovate[bot])
+- **deps:** Update typescript-eslint monorepo to v6.19.0 ([bc46e4c](https://github.com/tj-actions/changed-files/commit/bc46e4c4222c3926a70378d183f0b387d3a9e9a8))  - (renovate[bot])
+- **deps:** Update dependency @types/node to v20.11.2 ([fba4067](https://github.com/tj-actions/changed-files/commit/fba40673489d49e860c15a444c134d887ead1f3a))  - (renovate[bot])
+- **deps:** Update dependency @types/node to v20.11.1 ([e4b8674](https://github.com/tj-actions/changed-files/commit/e4b86747326bc58eb230d62188ebdd66b73721a9))  - (renovate[bot])
+- **deps:** Lock file maintenance ([bc2b5ae](https://github.com/tj-actions/changed-files/commit/bc2b5aef20add66cbe21d1093f0f1d37a353d376))  - (renovate[bot])
+- **deps:** Update dependency prettier to v3.2.2 ([63c36a5](https://github.com/tj-actions/changed-files/commit/63c36a563a30544b4c03a8426277dca4b00e4fd1))  - (renovate[bot])
+
+## <!-- 9 -->⬆️ Upgrades
+
+- Upgraded to v41.1.1 ([#1854](https://github.com/tj-actions/changed-files/issues/1854))
+
+Co-authored-by: jackton1 <jackton1@users.noreply.github.com> ([44b7750](https://github.com/tj-actions/changed-files/commit/44b77505fe3f2c6d0a76f72a4ef512e7c2ba0b6a))  - (tj-actions[bot])
+
 # [41.1.1](https://github.com/tj-actions/changed-files/compare/v41.1.0...v41.1.1) - (2024-01-13)
 
 ## <!-- 1 -->🐛 Bug Fixes

dist/index.js

@@ -1358,29 +1358,29 @@ exports.getSHAForPullRequestEvent = getSHAForPullRequestEvent;
 "use strict";
 
 Object.defineProperty(exports, "__esModule", ({ value: true }));
-exports.UNSUPPORTED_REST_API_INPUTS = void 0;
-exports.UNSUPPORTED_REST_API_INPUTS = [
-    'sha',
-    'baseSha',
-    'since',
-    'until',
-    'path',
-    'quotepath',
-    'diffRelative',
-    'sinceLastRemoteCommit',
-    'recoverDeletedFiles',
-    'recoverDeletedFilesToDestination',
-    'recoverFiles',
-    'recoverFilesSeparator',
-    'recoverFilesIgnore',
-    'recoverFilesIgnoreSeparator',
-    'includeAllOldNewRenamedFiles',
-    'oldNewSeparator',
-    'oldNewFilesSeparator',
-    'skipInitialFetch',
-    'fetchAdditionalSubmoduleHistory',
-    'dirNamesDeletedFilesIncludeOnlyDeletedDirs'
-];
+exports.DEFAULT_VALUES_OF_UNSUPPORTED_API_INPUTS = void 0;
+exports.DEFAULT_VALUES_OF_UNSUPPORTED_API_INPUTS = {
+    sha: '',
+    baseSha: '',
+    since: '',
+    until: '',
+    path: '.',
+    quotepath: true,
+    diffRelative: true,
+    sinceLastRemoteCommit: false,
+    recoverDeletedFiles: false,
+    recoverDeletedFilesToDestination: '',
+    recoverFiles: '',
+    recoverFilesSeparator: '\n',
+    recoverFilesIgnore: '',
+    recoverFilesIgnoreSeparator: '\n',
+    includeAllOldNewRenamedFiles: false,
+    oldNewSeparator: ',',
+    oldNewFilesSeparator: ' ',
+    skipInitialFetch: false,
+    fetchAdditionalSubmoduleHistory: false,
+    dirNamesDeletedFilesIncludeOnlyDeletedDirs: false
+};
 
 
 /***/ }),
@@ -1859,12 +1859,7 @@ function run() {
             ((_b = github.context.payload.pull_request) === null || _b === void 0 ? void 0 : _b.number) &&
             (!hasGitDirectory || inputs.useRestApi)) {
             core.info("Using GitHub's REST API to get changed files");
-            if (process.env.GITHUB_ACTION_PATH) {
-                yield (0, utils_1.warnUnsupportedRESTAPIInputs)({
-                    actionPath: path_1.default.join(process.env.GITHUB_ACTION_PATH, 'action.yml'),
-                    inputs
-                });
-            }
+            yield (0, utils_1.warnUnsupportedRESTAPIInputs)({ inputs });
             yield getChangedFilesFromRESTAPI({
                 inputs,
                 filePatterns,
@@ -2110,17 +2105,17 @@ function lineOfFileGenerator({ filePath, excludedFiles }) {
             for (var _d = true, rl_1 = __asyncValues(rl), rl_1_1; rl_1_1 = yield __await(rl_1.next()), _a = rl_1_1.done, !_a; _d = true) {
                 _c = rl_1_1.value;
                 _d = false;
-                const line = _c;
+                let line = _c;
                 if (!line.startsWith('#') && line !== '') {
                     if (excludedFiles) {
-                        if (line.startsWith('!')) {
-                            yield yield __await(line);
-                        }
-                        else {
-                            yield yield __await(`!${line}`);
+                        line = line.startsWith('!') ? line : `!${line}`;
+                        if (line.endsWith(path.sep)) {
+                            line = `${line}**`;
                         }
+                        yield yield __await(line);
                     }
                     else {
+                        line = line.endsWith(path.sep) ? `${line}**` : line;
                         yield yield __await(line);
                     }
                 }
@@ -2644,6 +2639,7 @@ const getFilePatterns = ({ inputs, workingDirectory }) => __awaiter(void 0, void
     if (inputs.files) {
         const filesPatterns = inputs.files
             .split(inputs.filesSeparator)
+            .map(p => (p.endsWith(path.sep) ? `${p}**` : p))
             .filter(Boolean);
         cleanedFilePatterns.push(...filesPatterns);
         core.debug(`files patterns: ${filesPatterns.join('\n')}`);
@@ -2665,8 +2661,9 @@ const getFilePatterns = ({ inputs, workingDirectory }) => __awaiter(void 0, void
             .split(inputs.filesIgnoreSeparator)
             .filter(Boolean)
             .map(p => {
-            if (!p.startsWith('!')) {
-                p = `!${p}`;
+            p = p.startsWith('!') ? p : `!${p}`;
+            if (p.endsWith(path.sep)) {
+                p = `${p}**`;
             }
             return p;
         });
@@ -2957,28 +2954,16 @@ exports.hasLocalGitDirectory = hasLocalGitDirectory;
 /**
  * Warns about unsupported inputs when using the REST API.
  *
- * @param actionPath - The path to the action file.
  * @param inputs - The inputs object.
  */
-const warnUnsupportedRESTAPIInputs = ({ actionPath, inputs }) => __awaiter(void 0, void 0, void 0, function* () {
-    var _m;
-    const actionContents = yield fs_1.promises.readFile(actionPath, 'utf8');
-    const actionYaml = (0, yaml_1.parseDocument)(actionContents, { schema: 'failsafe' });
-    if (actionYaml.errors.length > 0) {
-        throw new Error(`YAML errors in ${actionPath}: ${actionYaml.errors.join(', ')}`);
-    }
-    if (actionYaml.warnings.length > 0) {
-        throw new Error(`YAML warnings in ${actionPath}: ${actionYaml.warnings.join(', ')}`);
-    }
-    const action = actionYaml.toJS();
-    const actionInputs = action.inputs;
-    for (const key of constant_1.UNSUPPORTED_REST_API_INPUTS) {
-        const inputKey = (0, lodash_1.snakeCase)(key);
-        const defaultValue = Object.hasOwnProperty.call(actionInputs[inputKey], 'default')
-            ? actionInputs[inputKey].default.toString()
+const warnUnsupportedRESTAPIInputs = ({ inputs }) => __awaiter(void 0, void 0, void 0, function* () {
+    var _m, _o;
+    for (const key of Object.keys(constant_1.DEFAULT_VALUES_OF_UNSUPPORTED_API_INPUTS)) {
+        const defaultValue = Object.hasOwnProperty.call(constant_1.DEFAULT_VALUES_OF_UNSUPPORTED_API_INPUTS, key)
+            ? (_m = constant_1.DEFAULT_VALUES_OF_UNSUPPORTED_API_INPUTS[key]) === null || _m === void 0 ? void 0 : _m.toString()
             : '';
-        if (defaultValue !== ((_m = inputs[key]) === null || _m === void 0 ? void 0 : _m.toString())) {
-            core.warning(`Input "${inputKey}" is not supported when using GitHub's REST API to get changed files`);
+        if (defaultValue !== ((_o = inputs[key]) === null || _o === void 0 ? void 0 : _o.toString())) {
+            core.warning(`Input "${(0, lodash_1.snakeCase)(key)}" is not supported when using GitHub's REST API to get changed files`);
         }
     }
 });

package.json

@@ -1,6 +1,6 @@
 {
   "name": "@tj-actions/changed-files",
-  "version": "41.1.1",
+  "version": "41.1.2",
   "description": "Github action to retrieve all (added, copied, modified, deleted, renamed, type changed, unmerged, unknown) files and directories.",
   "main": "lib/main.js",
   "publishConfig": {

src/__tests__/utils.test.ts

@@ -1,6 +1,4 @@
 import * as core from '@actions/core'
-import {promises as fs} from 'fs'
-import path from 'path'
 import {ChangeTypeEnum} from '../changedFiles'
 import {Inputs} from '../inputs'
 import {
@@ -12,7 +10,6 @@ import {
 } from '../utils'
 
 const originalPlatform = process.platform
-const ACTION_PATH = path.resolve(__dirname, '..', '..', 'action.yml')
 
 function mockedPlatform(platform: string): void {
   Object.defineProperty(process, 'platform', {
@@ -644,97 +641,14 @@ describe('utils test', () => {
       const coreWarningSpy = jest.spyOn(core, 'warning')
 
       await warnUnsupportedRESTAPIInputs({
-        actionPath: ACTION_PATH,
         inputs
       })
 
       expect(coreWarningSpy).toHaveBeenCalledWith(
         'Input "sha" is not supported when using GitHub\'s REST API to get changed files'
       )
-    })
 
-    // Throws an error if there are YAML errors in the action file.
-    it('should throw an error if there are YAML errors in the action file', async () => {
-      const actionPath = './path/to/action.yml'
-      const inputs: Inputs = {
-        files: '',
-        filesSeparator: '\n',
-        filesFromSourceFile: '',
-        filesFromSourceFileSeparator: '\n',
-        filesYaml: '',
-        filesYamlFromSourceFile: '',
-        filesYamlFromSourceFileSeparator: '\n',
-        filesIgnore: '',
-        filesIgnoreSeparator: '\n',
-        filesIgnoreFromSourceFile: '',
-        filesIgnoreFromSourceFileSeparator: '\n',
-        filesIgnoreYaml: '',
-        filesIgnoreYamlFromSourceFile: '',
-        filesIgnoreYamlFromSourceFileSeparator: '\n',
-        separator: ' ',
-        includeAllOldNewRenamedFiles: false,
-        oldNewSeparator: ',',
-        oldNewFilesSeparator: ' ',
-        sha: '1313123',
-        baseSha: '',
-        since: '',
-        until: '',
-        path: '.',
-        quotepath: true,
-        diffRelative: true,
-        dirNames: false,
-        dirNamesMaxDepth: undefined,
-        dirNamesExcludeCurrentDir: false,
-        dirNamesIncludeFiles: '',
-        dirNamesIncludeFilesSeparator: '\n',
-        dirNamesDeletedFilesIncludeOnlyDeletedDirs: false,
-        json: false,
-        escapeJson: true,
-        safeOutput: true,
-        fetchDepth: 50,
-        fetchAdditionalSubmoduleHistory: false,
-        sinceLastRemoteCommit: false,
-        writeOutputFiles: false,
-        outputDir: '.github/outputs',
-        outputRenamedFilesAsDeletedAndAdded: false,
-        recoverDeletedFiles: false,
-        recoverDeletedFilesToDestination: '',
-        recoverFiles: '',
-        recoverFilesSeparator: '\n',
-        recoverFilesIgnore: '',
-        recoverFilesIgnoreSeparator: '\n',
-        token: '${{ github.token }}',
-        apiUrl: '${{ github.api_url }}',
-        skipInitialFetch: false,
-        failOnInitialDiffError: false,
-        failOnSubmoduleDiffError: false,
-        negationPatternsFirst: false,
-        useRestApi: false
-      }
-
-      // Mocking readFile to return action file contents with errors
-      jest.spyOn(fs, 'readFile').mockResolvedValue(`
-        inputs:
-          files:
-            description: Files
-            required: true
-            default: ""
-          sha:
-            description: SHA
-            required: true
-            default: abc123
-          token:
-            description: Token
-            required: true
-            default: my-token
-        warnings:
-          | Invalid input value`)
-
-      await expect(
-        warnUnsupportedRESTAPIInputs({actionPath, inputs})
-      ).rejects.toThrow(
-        /YAML errors in .\/path\/to\/action.yml: YAMLParseError: Not a YAML token: Invalid input value at line 16, column 13:/
-      )
+      expect(coreWarningSpy).toHaveBeenCalledTimes(1)
     })
   })
 })

src/constant.ts

@@ -1,24 +1,24 @@
 import {Inputs} from './inputs'
 
-export const UNSUPPORTED_REST_API_INPUTS: (keyof Inputs)[] = [
-  'sha',
-  'baseSha',
-  'since',
-  'until',
-  'path',
-  'quotepath',
-  'diffRelative',
-  'sinceLastRemoteCommit',
-  'recoverDeletedFiles',
-  'recoverDeletedFilesToDestination',
-  'recoverFiles',
-  'recoverFilesSeparator',
-  'recoverFilesIgnore',
-  'recoverFilesIgnoreSeparator',
-  'includeAllOldNewRenamedFiles',
-  'oldNewSeparator',
-  'oldNewFilesSeparator',
-  'skipInitialFetch',
-  'fetchAdditionalSubmoduleHistory',
-  'dirNamesDeletedFilesIncludeOnlyDeletedDirs'
-]
+export const DEFAULT_VALUES_OF_UNSUPPORTED_API_INPUTS: Partial<Inputs> = {
+  sha: '',
+  baseSha: '',
+  since: '',
+  until: '',
+  path: '.',
+  quotepath: true,
+  diffRelative: true,
+  sinceLastRemoteCommit: false,
+  recoverDeletedFiles: false,
+  recoverDeletedFilesToDestination: '',
+  recoverFiles: '',
+  recoverFilesSeparator: '\n',
+  recoverFilesIgnore: '',
+  recoverFilesIgnoreSeparator: '\n',
+  includeAllOldNewRenamedFiles: false,
+  oldNewSeparator: ',',
+  oldNewFilesSeparator: ' ',
+  skipInitialFetch: false,
+  fetchAdditionalSubmoduleHistory: false,
+  dirNamesDeletedFilesIncludeOnlyDeletedDirs: false
+}

src/main.ts

@@ -256,12 +256,7 @@ export async function run(): Promise<void> {
     (!hasGitDirectory || inputs.useRestApi)
   ) {
     core.info("Using GitHub's REST API to get changed files")
-    if (process.env.GITHUB_ACTION_PATH) {
-      await warnUnsupportedRESTAPIInputs({
-        actionPath: path.join(process.env.GITHUB_ACTION_PATH, 'action.yml'),
-        inputs
-      })
-    }
+    await warnUnsupportedRESTAPIInputs({inputs})
     await getChangedFilesFromRESTAPI({
       inputs,
       filePatterns,

src/utils.ts

@@ -10,7 +10,7 @@ import {createInterface} from 'readline'
 import {parseDocument} from 'yaml'
 import {ChangedFiles, ChangeTypeEnum} from './changedFiles'
 import {DiffResult} from './commitSha'
-import {UNSUPPORTED_REST_API_INPUTS} from './constant'
+import {DEFAULT_VALUES_OF_UNSUPPORTED_API_INPUTS} from './constant'
 import {Inputs} from './inputs'
 
 const MINIMUM_GIT_VERSION = '2.18.0'
@@ -171,15 +171,16 @@ async function* lineOfFileGenerator({
     input: fileStream,
     crlfDelay: Infinity
   })
-  for await (const line of rl) {
+  for await (let line of rl) {
     if (!line.startsWith('#') && line !== '') {
       if (excludedFiles) {
-        if (line.startsWith('!')) {
-          yield line
-        } else {
-          yield `!${line}`
+        line = line.startsWith('!') ? line : `!${line}`
+        if (line.endsWith(path.sep)) {
+          line = `${line}**`
         }
+        yield line
       } else {
+        line = line.endsWith(path.sep) ? `${line}**` : line
         yield line
       }
     }
@@ -998,6 +999,7 @@ export const getFilePatterns = async ({
   if (inputs.files) {
     const filesPatterns = inputs.files
       .split(inputs.filesSeparator)
+      .map(p => (p.endsWith(path.sep) ? `${p}**` : p))
       .filter(Boolean)
 
     cleanedFilePatterns.push(...filesPatterns)
@@ -1029,8 +1031,9 @@ export const getFilePatterns = async ({
       .split(inputs.filesIgnoreSeparator)
       .filter(Boolean)
       .map(p => {
-        if (!p.startsWith('!')) {
-          p = `!${p}`
+        p = p.startsWith('!') ? p : `!${p}`
+        if (p.endsWith(path.sep)) {
+          p = `${p}**`
         }
         return p
       })
@@ -1513,52 +1516,28 @@ export const hasLocalGitDirectory = async ({
 /**
  * Warns about unsupported inputs when using the REST API.
  *
- * @param actionPath - The path to the action file.
  * @param inputs - The inputs object.
  */
 export const warnUnsupportedRESTAPIInputs = async ({
-  actionPath,
   inputs
 }: {
-  actionPath: string
   inputs: Inputs
 }): Promise<void> => {
-  const actionContents = await fs.readFile(actionPath, 'utf8')
-  const actionYaml = parseDocument(actionContents, {schema: 'failsafe'})
-
-  if (actionYaml.errors.length > 0) {
-    throw new Error(
-      `YAML errors in ${actionPath}: ${actionYaml.errors.join(', ')}`
-    )
-  }
-
-  if (actionYaml.warnings.length > 0) {
-    throw new Error(
-      `YAML warnings in ${actionPath}: ${actionYaml.warnings.join(', ')}`
-    )
-  }
-
-  const action = actionYaml.toJS() as {
-    inputs: {
-      [key: string]: {description: string; required: boolean; default: string}
-    }
-  }
-
-  const actionInputs = action.inputs
-
-  for (const key of UNSUPPORTED_REST_API_INPUTS) {
-    const inputKey = snakeCase(key) as keyof Inputs
-
+  for (const key of Object.keys(DEFAULT_VALUES_OF_UNSUPPORTED_API_INPUTS)) {
     const defaultValue = Object.hasOwnProperty.call(
-      actionInputs[inputKey],
-      'default'
+      DEFAULT_VALUES_OF_UNSUPPORTED_API_INPUTS,
+      key
     )
-      ? actionInputs[inputKey].default.toString()
+      ? DEFAULT_VALUES_OF_UNSUPPORTED_API_INPUTS[
+          key as keyof Inputs
+        ]?.toString()
       : ''
 
-    if (defaultValue !== inputs[key]?.toString()) {
+    if (defaultValue !== inputs[key as keyof Inputs]?.toString()) {
       core.warning(
-        `Input "${inputKey}" is not supported when using GitHub's REST API to get changed files`
+        `Input "${snakeCase(
+          key
+        )}" is not supported when using GitHub's REST API to get changed files`
       )
     }
   }

yarn.lock

@@ -3426,9 +3426,9 @@ prettier-linter-helpers@^1.0.0:
     fast-diff "^1.1.2"
 
 prettier@^3.0.0:
-  version "3.2.3"
-  resolved "https://registry.yarnpkg.com/prettier/-/prettier-3.2.3.tgz#98501d99141a9a10d5ceaf74cf39c8b7cbddd380"
-  integrity sha512-QNhUTBq+mqt1oH1dTfY3phOKNhcDdJkfttHI6u0kj7M2+c+7fmNKlgh2GhnHiqMcbxJ+a0j2igz/2jfl9QKLuw==
+  version "3.2.4"
+  resolved "https://registry.yarnpkg.com/prettier/-/prettier-3.2.4.tgz#4723cadeac2ce7c9227de758e5ff9b14e075f283"
+  integrity sha512-FWu1oLHKCrtpO1ypU6J0SbK2d9Ckwysq6bHj/uaCP26DxrPpppCLQRGVuqAxSTvhF00AcvDRyYrLNW7ocBhFFQ==
 
 pretty-format@^29.0.0, pretty-format@^29.7.0:
   version "29.7.0"