Merge pull request #14 from usernameseb/master

Customization Options

README.md

@@ -44,8 +44,35 @@ jobs:
         uses: wyozi/contextual-qa-checklist-action@master
         with:
           gh-token: ${{ secrets.GITHUB_TOKEN }}
+          # See options documentation below
 ```
 
+#### Options
+
+##### `comment-header`
+
+Overrides the default header text in the PR comment.
+
+##### `comment-footer`
+
+Overrides the default footer text in the PR comment.
+
+##### `include-hidden-files`
+
+Includes files and folders starting with `.` when matching. Defaults to `false`.
+
+##### `input-file`
+
+The path to the checklist definition file. Default to `CHECKLIST.yml` in the project root.
+
+##### `gh-token`
+
+The Github token for you project.
+
+##### `show-paths`
+
+Shows the matched file path in the PR comment. Defaults to `true`.
+
 #### Result
 
 When matching files are updated in a PR, the action will automatically post a checklist containing items under that path's key.

action.yml

@@ -1,13 +1,29 @@
 name: "Contextual QA Checklists"
 description: "Submit a comment to PRs with a QA checklist based on context"
 inputs:
+  comment-header:
+    description: "Header text for the Github comment"
+    required: true
+    default: "Great PR! Please pay attention to the following items before merging:"
+  comment-footer:
+    description: "Footer text for the Github comment"
+    required: true
+    default: "This is an automatically generated QA checklist based on modified files"
+  include-hidden-files:
+    description: "Includes files and folders starting with '.' in file pattern matching"
+    required: true
+    default: false
   input-file:
     description: "Path to file containing checklist definitions"
     required: true
     default: "CHECKLIST.yml"
   gh-token:
     description: "GH Token"
     required: true
+  show-paths:
+    description: "Shows the matched file paths in the Github comment"
+    required: true
+    default: true
 runs:
   using: "node12"
   main: "dist/index.js"