feat: no key word customization (#78)

Author: henrygriffiths

.github/workflows/main.yml

@@ -47,6 +47,20 @@ jobs:
         prtitle: 'test: none: example title'
         allownokey: true
 
+  pr_lint_pass_nokey_nokeyword:
+    runs-on: ubuntu-latest
+    name: pr_lint_pass_nokey_nokeyword
+    steps:
+    - name: checkout
+      uses: actions/checkout@v3
+    - name: pr_lint_pass_nokey_nokeyword
+      id: pr_lint_pass_nokey_nokeyword
+      uses: ./
+      with:
+        issuekey: 'issue'
+        prtitle: 'test: nada: example title'
+        nokeyword: 'nada'
+
   pr_lint_pass_multikey:
     runs-on: ubuntu-latest
     name: pr_lint_pass_multikey
@@ -375,6 +389,42 @@ jobs:
       run: |
         if [[ ${{ steps.pr_lint_fail_nokey_allownokey.outcome }} == "failure" ]]; then exit 0; else exit 1; fi
 
+  pr_lint_fail_nokeyword:
+    runs-on: ubuntu-latest
+    name: pr_lint_fail_nokeyword
+    steps:
+    - name: checkout
+      uses: actions/checkout@v3
+    - name: pr_lint_fail_nokeyword
+      id: pr_lint_fail_nokeyword
+      continue-on-error: true
+      uses: ./
+      with:
+        issuekey: 'issue'
+        prtitle: 'test: none: example title'
+        nokeyword: 'invalid'
+    - name: Invert Status
+      run: |
+        if [[ ${{ steps.pr_lint_fail_nokeyword.outcome }} == "failure" ]]; then exit 0; else exit 1; fi
+
+  pr_lint_fail_nokeyword_regex:
+    runs-on: ubuntu-latest
+    name: pr_lint_fail_nokeyword_regex
+    steps:
+    - name: checkout
+      uses: actions/checkout@v3
+    - name: pr_lint_fail_nokeyword_regex
+      id: pr_lint_fail_nokeyword_regex
+      continue-on-error: true
+      uses: ./
+      with:
+        issuekey: 'issue'
+        prtitle: 'test: invalid 0: example title'
+        nokeyword_regex: 'invalid 0'
+    - name: Invert Status
+      run: |
+        if [[ ${{ steps.pr_lint_fail_nokeyword_regex.outcome }} == "failure" ]]; then exit 0; else exit 1; fi
+
   pr_lint_checktitle:
     runs-on: ubuntu-latest
     name: pr_lint_checktitle

README.md

@@ -30,6 +30,11 @@ Multiple issue keys: `fix(deps): issue-123, key-1234: fixing deps`
     # Allow linting to pass when no issue key is provided
     # Default: true
     allownokey: true
+    
+    # Optional
+    # Word used when no issue key is provided
+    # Default: none
+    nokeyword: ''
 ```
 
 

action.yml

@@ -18,6 +18,10 @@ inputs:
         description: 'Allow No Issue Key'
         required: false
         default: true
+    nokeyword:
+        description: 'No Issue Key Word'
+        required: false
+        default: 'none'
 runs:
     using: 'node16'
     main: './dist/index.js'

dist/index.js

@@ -8954,8 +8954,13 @@ try {
     } else {
         var allownokey = true
     }
+    if (core.getInput('nokeyword')) {
+        var nokeyword = core.getInput('nokeyword').toLowerCase().replace(/[^a-z]/g, '')
+    } else {
+        var nokeyword = 'none'
+    }
     if (allownokey) {
-        var allownokeyregex = '|none'
+        var allownokeyregex = '|' + nokeyword
     } else {
         var allownokeyregex = ''
     }

index.js

@@ -20,8 +20,13 @@ try {
     } else {
         var allownokey = true
     }
+    if (core.getInput('nokeyword')) {
+        var nokeyword = core.getInput('nokeyword').toLowerCase().replace(/[^a-z]/g, '')
+    } else {
+        var nokeyword = 'none'
+    }
     if (allownokey) {
-        var allownokeyregex = '|none'
+        var allownokeyregex = '|' + nokeyword
     } else {
         var allownokeyregex = ''
     }