Add support for skipping when description matches a regex pattern (#49)

* Added skipDescriptionRegex
* Added skip description regex args
* condensed the readme example

README.md

@@ -51,6 +51,25 @@ jobs:
           issueNumber: ${{ github.event.workflow_run.pull_requests[0].number }}
 ```
 
+### Optional checkboxes
+
+Optional checkboxes can be applied with the `skipDescriptionRegex` and `skipDescriptionRegexFlags` arguments, which correspond to the first and second constructor arguments of [Javascript's RegExp class](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/RegExp).
+
+Here is an example of skipping any description with including "(Optional)". (case-insensitive).
+
+```yaml
+# ...
+
+jobs:
+  job1:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: mheap/require-checklist-action@v2
+        with:
+          skipDescriptionRegex: .*\(optional\).*
+          skipDescriptionRegexFlags: i
+```
+
 ### Inapplicable checklist items
 
 In case there are some items that are not applicable in given checklist they can be ~stroked through~ and this action will ignore them. For example:

action.yml

@@ -19,3 +19,7 @@ inputs:
     description: Do not look for checklists in comments
     required: false
     default: "false"
+  skipDescriptionRegex:
+    description: A regex pattern of descriptions that will be skipped if matched
+    required: false
+    default: undefined

index.js

@@ -10,6 +10,9 @@ async function action() {
 
   const token = core.getInput("token");
   const octokit = github.getOctokit(token);
+  const skipRegexPattern = core.getInput("skipDescriptionRegex");
+  const skipRegexFlags = core.getInput("skipDescriptionRegexFlags");
+  const skipDescriptionRegex = !!skipRegexPattern ? new RegExp(skipRegexPattern, skipRegexFlags) : false;
 
   const issueNumber =
     core.getInput("issueNumber") || github.context.issue?.number;
@@ -61,6 +64,11 @@ async function action() {
         for (let item of matches) {
           var is_complete = item[1] != " ";
 
+          if(skipRegexPattern && skipDescriptionRegex.test(item[2])) {
+            console.log("Skipping task list item: " + item[2]);
+            continue;
+          }
+
           containsChecklist = true;
 
           if (is_complete) {

index.test.js

@@ -288,6 +288,29 @@ describe("Require Checklist", () => {
       "There are no incomplete task list items"
     );
   });
+
+  it("ignores items that match the skipDescriptionRegex + skipDescriptionRegexFlags args", async () => {
+    process.env.INPUT_REQUIRECHECKLIST = "true";
+    process.env.INPUT_SKIPDESCRIPTIONREGEX = ".*\(optional\).*";
+    process.env.INPUT_SKIPDESCRIPTIONREGEXFLAGS = "i";
+
+    mockIssueBody("Demo\r\n\r\n- [x] One\r\n- [x] Two\n- [x] This is (Optional) skipped");
+
+    console.log = jest.fn();
+
+    await action(tools);
+
+    expect(console.log).toBeCalledWith("Completed task list item: One");
+    expect(console.log).toBeCalledWith("Completed task list item: Two");
+    expect(console.log).toBeCalledWith("Skipping task list item: This is (Optional) skipped");
+
+    expect(console.log).toBeCalledWith(
+      "There are no incomplete task list items"
+    );
+
+    delete process.env.INPUT_SKIPDESCRIPTIONREGEX;
+    delete process.env.INPUT_SKIPDESCRIPTIONREGEXFLAGS;
+  });
 });
 
 function mockIssueBody(body, issueNumber = 17) {