✨ feat: support bypass CI by comment (#8)

Author: SigureMo

.github/workflows/example-workflow.yml

@@ -8,6 +8,9 @@ on:
     branches:
       - main
 
+env:
+  ACTIONS_RUNNER_DEBUG: true
+
 jobs:
   check-bypass:
     name: Check Bypass
@@ -32,11 +35,16 @@ jobs:
           type: 'composite'
           composite-rule: |
             {
-              "all": [
+              "any": [
                 {
                   "type": "labeled",
                   "label": ["ci-bypass: example", "ci-bypass: all"],
                   "username": ["SigureMo"]
+                },
+                {
+                  "type": "commented",
+                  "comment-pattern": [".+/bypass example.+", ".+/bypass all.+"],
+                  "username": ["SigureMo"]
                 }
               ]
             }

__tests__/rules.test.ts

@@ -1,4 +1,4 @@
-import { describe, it, assert } from 'vitest'
+import { describe, it } from 'vitest'
 import { ByPassCheckerBuilder } from '../src/rules/index.js'
 import { AbstractRule } from '../src/rules/base.js'
 import { type PullRequestContext } from '../src/context.js'

action.yml

@@ -1,5 +1,5 @@
 name: 'ci-bypass'
-description: 'A GitHub Action to bypass CI checks based on rules'
+description: 'Bypass CI checks for GitHub Actions'
 author: 'SigureMo'
 
 # Add your action's branding here. This will appear on the GitHub Marketplace.
@@ -9,25 +9,34 @@ branding:
 
 # Define your inputs here.
 inputs:
+  # Basic options
   github-token:
     description: 'GitHub token to interact with the GitHub API'
     required: false
   non-pull-request-event-strategy:
     description: 'Strategy to apply to non-pull-request events, can be always-skipped, never-skipped, or always-failed, default is always-failed'
     required: true
     default: 'always-failed'
+  # Select the type of the rule
   type:
     description: 'Type of the rule, can be labeled, commented, approved, or composite'
     required: true
-  label:
-    description: 'Label name, can be a string or an array of strings'
-    required: false
+  # Common options for all types
   username:
-    description: 'Username, can be a string or an array of strings'
+    description: 'Username, can be a string or an array of strings separated by |'
     required: false
   user-team:
-    description: 'User team, can be a string or an array of strings'
+    description: 'User team, can be a string or an array of strings separated by |'
+    required: false
+  # For labeled rule
+  label:
+    description: 'Label name, can be a string or an array of strings separated by |'
+    required: false
+  # For commented rule
+  comment-pattern:
+    description: 'Comment regex pattern, can be a string or an array of strings separated by |'
     required: false
+  # For commented rule
   composite-rule:
     description: 'Use any, all or not to combine multiple rules, need to be a JSON string'
     required: false