CH-13129 - enable exemptions by username(s) (#4)

CHANGELOG.md

@@ -0,0 +1,13 @@
+# Changelog
+
+## 1.2.0 (June 17, 2020)
+
+Provide a configuration option to exempt users from the action rules. Most useful for automated and bot PRs.
+
+## 1.1.0 (May 17, 2020)
+
+Added detection of ticket checking to include branches
+
+## 1.0.0 (April 8, 2020)
+
+Initial release! :tada:

README.md

@@ -41,7 +41,7 @@ jobs:
 
     steps:
       - name: Check for ticket
-        uses: neofinancial/ticket-check-action@v1.1.0
+        uses: neofinancial/ticket-check-action@v1
         with:
           token: ${{ secrets.GITHUB_TOKEN }}
           ticketPrefix: '#'
@@ -67,7 +67,7 @@ jobs:
 
     steps:
       - name: Check for ticket
-        uses: neofinancial/ticket-check-action@v1.1.0
+        uses: neofinancial/ticket-check-action@v1
         with:
           token: ${{ secrets.GITHUB_TOKEN }}
           ticketPrefix: 'PROJ-'
@@ -93,7 +93,7 @@ jobs:
 
     steps:
       - name: Check for ticket
-        uses: neofinancial/ticket-check-action@v1.1.0
+        uses: neofinancial/ticket-check-action@v1
         with:
           token: ${{ secrets.GITHUB_TOKEN }}
           ticketPrefix: 'CH-'
@@ -120,6 +120,7 @@ jobs:
 | bodyRegexFlags    |          | The flags applied to the body regular expression when searching for a shorthand reference                                                            | gim                   |
 | bodyURLRegex      |          | The regular expression used to search the body for a URL reference (example `https://github.com/octocat/hello-world/issues/1`)                       |                       |
 | bodyURLRegexFlags |          | The flags applied to the body regular expression when searching for a URL reference                                                                  | gim                   |
+| exemptUsers       |          | Comma seperated string of usernames that will be exempt from all checks. Most useful for bot/automated PRs (example "octocat,dependabot")            |                       |
 
 ## Caveat
 

action.yml

@@ -53,6 +53,11 @@ inputs:
     default: 'gim'
     required: true
 
+  exemptUsers:
+    description: 'User(s) who will be exempt from the ticket check rules. Particularly useful for automated/bot PRs'
+    default: ''
+    required: false
+
   token:
     description: 'GitHub authentication token'
     required: true

package.json

@@ -1,7 +1,7 @@
 {
   "name": "ticket-check-action",
   "description": "Verify that your pull request titles start with a ticket ID",
-  "version": "1.1.0",
+  "version": "1.2.0",
   "author": "Neo Financial Engineering <[email protected]>",
   "license": "MIT",
   "repository": {

src/index.ts

@@ -38,6 +38,19 @@ async function run(): Promise<void> {
     const token = getInput('token', { required: true });
     const client = new GitHub(token);
     const pullRequest = context.issue;
+    const { sender } = context.payload;
+
+    // Exempt Users
+    const exemptUsers = getInput('exemptUsers', { required: true })
+      .split(',')
+      .map(user => user.trim());
+
+    if (sender && exemptUsers.includes(sender.login)) {
+      debug('User is listed as exempt');
+      debug(`Exempt Users: ${exemptUsers.join(', ')}`);
+      debug(`Pull Request Owner: ${sender.login}`);
+      return;
+    }
 
     // get the title format and ticket prefix
     const ticketPrefix = getInput('ticketPrefix', { required: true });