feat(generated-files-bot): configurable list of PR authors to ignore (#…

…1254) Fixes #1096
googleapis · Dec 16, 2020 · d3c42d5 · d3c42d5
1 parent 8f86abb
commit d3c42d5
Show file tree

Hide file tree

Showing 4 changed files with 36 additions and 0 deletions.
diff --git a/packages/generated-files-bot/README.md b/packages/generated-files-bot/README.md
@@ -24,6 +24,7 @@ options:
 | ---- | ----------- | ---- | ------- |
 | `generatedFiles`    | An explicit list of files which are considered templates. | `string[]` | `[]` |
 | `externalManifests` | List of external manifest files to parse. | `ExternalManifest[]` | `[]` |
+| `ignoreAuthors` | List of PR authors to ignore. | `string[]` | `[]` |
 
 External Manifest:
 

diff --git a/packages/generated-files-bot/src/generated-files-bot.ts b/packages/generated-files-bot/src/generated-files-bot.ts
@@ -31,6 +31,7 @@ interface ExternalManifest {
 export interface Configuration {
   generatedFiles?: string[];
   externalManifests?: ExternalManifest[];
+  ignoreAuthors?: string[];
 }
 
 /**
@@ -165,6 +166,12 @@ export function handler(app: Application) {
     const owner = context.payload.repository.owner.login;
     const repo = context.payload.repository.name;
     const pullNumber = context.payload.pull_request.number;
+    const prAuthor = context.payload.pull_request.user.login;
+
+    // ignore PRs from a configurable list of authors
+    if (config.ignoreAuthors?.includes(prAuthor)) {
+      return;
+    }
 
     // Read the list of templated files
     const templatedFiles = new Set(

diff --git a/packages/generated-files-bot/test/fixtures/config/ignore-authors.yml b/packages/generated-files-bot/test/fixtures/config/ignore-authors.yml
@@ -0,0 +1,11 @@
+generatedFiles:
+- 'file1.txt'
+externalManifests:
+- type: json
+  file: 'manifest.json'
+  jsonpath: '$.key1[*]'
+- type: 'yaml'
+  file: 'manifest.yaml'
+  jsonpath: '$.key2.key3[*]'
+ignoreAuthors:
+- testuser2
diff --git a/packages/generated-files-bot/test/generated-files-bot.ts b/packages/generated-files-bot/test/generated-files-bot.ts
@@ -404,6 +404,23 @@ describe('generated-files-bot', () => {
         });
         requests.done();
       });
+
+      it('ignores PRs from configured autors', async () => {
+        const validConfig = fs.readFileSync(
+          resolve(fixturesPath, 'config', 'ignore-authors.yml')
+        );
+        requests = requests
+          .get(
+            '/repos/testOwner/testRepo/contents/.github%2Fgenerated-files-bot.yml'
+          )
+          .reply(200, validConfig);
+        await probot.receive({
+          name: 'pull_request',
+          payload: payload,
+          id: 'abc123',
+        });
+        requests.done();
+      });
     });
   });
 });