Merge pull request #6 from worksome/feature/ignored-files

feat: add support to filter specific files

Author: owenvoke

README.md

@@ -24,6 +24,10 @@ Enable checkboxes when listing the files in the comment. The default value is `f
 
 Enable the inclusion of deleted files when checking for code owners. The default value is `false`.
 
+### `ignoredFiles`
+
+Ignore specific files using a new-line-separated list of files.
+
 ### `token`
 
 The token used to authenticate with GitHub and post the comments on the PR. Defaults to `github.token`.
@@ -49,6 +53,9 @@ The output comment that should be posted on the pull request.
     commentSuffix: ''
     checkboxes: true
     includeDeleted: false
+    ignoredFiles: |
+      README.md
+      composer.json
     token: ${{ github.token }}
 ```
 
@@ -65,5 +72,8 @@ The output comment that should be posted on the pull request.
     commentSuffix: ''
     checkboxes: true
     includeDeleted: false
+    ignoredFiles: |
+      README.md
+      composer.json
     token: ${{ github.token }}
 ```

__tests__/enforcer.test.ts

@@ -1,4 +1,4 @@
-import { checkFiles, generateIgnore } from '../src/enforcer'
+import { checkFiles, generateIgnore, getIgnoredFiles } from '../src/enforcer'
 
 import * as core from '@actions/core'
 import ignore, { Ignore } from 'ignore'
@@ -33,3 +33,14 @@ describe('checkFiles', () => {
     expect(result).toEqual(['bar.txt'])
   })
 })
+
+describe('ignoredFiles', () => {
+  it('returns an empty array when all files have a code owner', async () => {
+    const result = await getIgnoredFiles(`
+foo.txt
+bar.txt
+    `)
+
+    expect(result).toEqual(['foo.txt', 'bar.txt'])
+  })
+})

action.yml

@@ -18,6 +18,9 @@ inputs:
   includeDeleted:
     description: 'Include deleted files.'
     default: false
+  ignoredFiles:
+    description: 'A new-line-separated list of ignored files.'
+    default: ''
   token:
     description: 'The token used to authenticate with GitHub and post the comments on the PR.'
     default: ${{ github.server_url == 'https://github.com' && github.token || '' }}

composite/with-comment/action.yml

@@ -18,6 +18,9 @@ inputs:
   includeDeleted:
     description: 'Include deleted files.'
     default: false
+  ignoredFiles:
+    description: 'A new-line-separated list of ignored files.'
+    default: ''
   custom-comment-identifier:
     description: 'A string that will be used to identify existing comments to update.'
     default: 'CODEOWNERS ACTION'
@@ -39,6 +42,9 @@ runs:
         commentSuffix: |
           ${{ inputs.commentSuffix }}
         checkboxes: ${{ inputs.checkboxes }}
+        includeDeleted: ${{ inputs.includeDeleted }}
+        ignoredFiles: |
+          ${{ inputs.ignoredFiles }}
         token: ${{ inputs.token }}
 
     - name: Find Existing Comment

dist/index.js

@@ -42,7 +42,7 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
     return (mod && mod.__esModule) ? mod : { "default": mod };
 };
 Object.defineProperty(exports, "__esModule", ({ value: true }));
-exports.postComment = exports.checkFiles = exports.generateIgnore = exports.run = void 0;
+exports.postComment = exports.checkFiles = exports.getIgnoredFiles = exports.generateIgnore = exports.run = void 0;
 const fs_1 = __nccwpck_require__(7147);
 const core = __importStar(__nccwpck_require__(2186));
 const github = __importStar(__nccwpck_require__(5438));
@@ -56,6 +56,7 @@ function run() {
             const commentSuffix = core.getInput('commentSuffix') || '';
             const checkboxes = core.getBooleanInput('checkboxes') || false;
             const includeDeleted = core.getBooleanInput('includeDeleted') || false;
+            const ignoredFiles = yield getIgnoredFiles(core.getInput('ignoredFiles') || '');
             const prNumber = getPrNumber();
             if (!prNumber) {
                 console.log('Could not get pull request number from context, exiting');
@@ -66,6 +67,7 @@ function run() {
             const changedFiles = yield getChangedFiles(client, prNumber, includeDeleted);
             const ignored = (0, ignore_1.default)();
             generateIgnore(ignored, codeOwnersPath);
+            ignoredFiles.forEach((ignoredFile) => ignored.add(ignoredFile));
             const result = yield checkFiles(ignored, changedFiles);
             if (result.length !== 0) {
                 yield postComment(result, checkboxes, commentPrefix, commentSuffix);
@@ -103,13 +105,36 @@ function getChangedFiles(client, prNumber, includeDeleted) {
         const changedFiles = listFilesResponse
             .filter((f) => includeDeleted || f.status !== 'deleted')
             .map((f) => f.filename);
-        core.debug('Found changed files:');
-        for (const file of changedFiles) {
-            core.debug(`  ${file}`);
+        if (changedFiles.length > 0) {
+            core.debug('Found changed files:');
+            for (const file of changedFiles) {
+                core.debug(`  ${file}`);
+            }
+        }
+        else {
+            core.debug('No changed files were found.');
         }
         return changedFiles;
     });
 }
+function getIgnoredFiles(ignoredLinesList) {
+    return __awaiter(this, void 0, void 0, function* () {
+        const ignoredFiles = ignoredLinesList
+            .split('\n')
+            .filter((ignoredFile) => ignoredFile.trim().length > 0);
+        if (ignoredFiles.length > 0) {
+            core.debug('Ignoring files:');
+            for (const file of ignoredFiles) {
+                core.debug(`  ${file}`);
+            }
+        }
+        else {
+            core.debug('No ignored files were found.');
+        }
+        return ignoredFiles;
+    });
+}
+exports.getIgnoredFiles = getIgnoredFiles;
 function checkFiles(ig, changedFiles) {
     return __awaiter(this, void 0, void 0, function* () {
         const failedList = [];

src/enforcer.ts

@@ -1,7 +1,8 @@
-import { existsSync, readFileSync } from 'fs'
+import { existsSync, readFileSync, createReadStream } from 'fs'
 import * as core from '@actions/core'
 import * as github from '@actions/github'
 import ignore, { Ignore } from 'ignore'
+import * as readline from 'readline'
 
 type ClientType = ReturnType<typeof github.getOctokit>
 
@@ -16,6 +17,10 @@ export async function run(): Promise<void> {
     const includeDeleted: boolean =
       core.getBooleanInput('includeDeleted') || false
 
+    const ignoredFiles: string[] = await getIgnoredFiles(
+      core.getInput('ignoredFiles') || ''
+    )
+
     const prNumber = getPrNumber()
     if (!prNumber) {
       console.log('Could not get pull request number from context, exiting')
@@ -35,6 +40,8 @@ export async function run(): Promise<void> {
 
     generateIgnore(ignored, codeOwnersPath)
 
+    ignoredFiles.forEach((ignoredFile: string) => ignored.add(ignoredFile))
+
     const result = await checkFiles(ignored, changedFiles)
 
     if (result.length !== 0) {
@@ -79,14 +86,37 @@ async function getChangedFiles(
     .filter((f: any) => includeDeleted || f.status !== 'deleted')
     .map((f: any) => f.filename)
 
-  core.debug('Found changed files:')
-  for (const file of changedFiles) {
-    core.debug(`  ${file}`)
+  if (changedFiles.length > 0) {
+    core.debug('Found changed files:')
+    for (const file of changedFiles) {
+      core.debug(`  ${file}`)
+    }
+  } else {
+    core.debug('No changed files were found.')
   }
 
   return changedFiles
 }
 
+export async function getIgnoredFiles(
+  ignoredLinesList: string
+): Promise<string[]> {
+  const ignoredFiles: string[] = ignoredLinesList
+    .split('\n')
+    .filter((ignoredFile: string) => ignoredFile.trim().length > 0)
+
+  if (ignoredFiles.length > 0) {
+    core.debug('Ignoring files:')
+    for (const file of ignoredFiles) {
+      core.debug(`  ${file}`)
+    }
+  } else {
+    core.debug('No ignored files were found.')
+  }
+
+  return ignoredFiles
+}
+
 export async function checkFiles(
   ig: Ignore,
   changedFiles: string[]