Merge branch 'main' into shenxianpeng-patch-1

Author: shenxianpeng

.commit-check.yml

@@ -20,6 +20,6 @@ checks:
     suggest: run command `git config user.name "Your Name"`
 
   - check: author_email
-    regex: ^\S+@\S+\.\S+$
+    regex: ^.+@.+$
     error: The committer email seems invalid
     suggest: run command `git config user.email [email protected]`

.github/workflows/commit-check.yml

@@ -5,20 +5,19 @@ on:
     branches: 'main'
   workflow_dispatch:
 
-permissions: # used by `pr-comments`
-  contents: write
-  pull-requests: write
-
 jobs:
   commit-check:
     runs-on: ubuntu-latest
+    permissions:  # use permissions because of use pr-comments
+      contents: read
+      pull-requests: write
     steps:
       - uses: actions/checkout@v4
         with:
-          ref: ${{ github.event.pull_request.head.sha }}
-      - uses: ./  # self test
+          ref: ${{ github.event.pull_request.head.sha }}  # checkout PR HEAD commit
+      - uses: ./ # self test
         env:
-          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}  # used by `pr-comments`
+          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }} # use GITHUB_TOKEN because of use pr-comments
         with:
           message: true
           branch: true

README.md

@@ -23,17 +23,16 @@ on:
 jobs:
   commit-check:
     runs-on: ubuntu-latest
-    permissions:
+    permissions:  # use permissions because of use pr-comments
       contents: read
-      issues: write
       pull-requests: write
     steps:
       - uses: actions/checkout@v4
         with:
-          ref: ${{ github.event.pull_request.head.sha }} # Checkout PR HEAD commit
+          ref: ${{ github.event.pull_request.head.sha }}  # checkout PR HEAD commit
       - uses: commit-check/commit-check-action@v1
         env:
-          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }} # use GITHUB_TOKEN because of use pr-comments
         with:
           message: true
           branch: true

requirements.txt

@@ -1,5 +1,5 @@
 # Install commit-check CLI
 # For details please see: https://github.com/commit-check/commit-check
-commit-check==0.8.4
+commit-check==0.8.5
 # Interact with the GitHub API.
 PyGithub==2.4.0