docs: update readme

openGemini · Oct 28, 2024 · 1fedd28 · 1fedd28
1 parent 3e80179
commit 1fedd28
Show file tree

Hide file tree

Showing 2 changed files with 9 additions and 2 deletions.
diff --git a/README.md b/README.md
@@ -19,7 +19,7 @@ jobs:
     steps:
       - uses: actions/checkout@v4
       - name: Common PR Title Checker
-        uses: xuthus5/pr-title-checker@v0.0.5
+        uses: xuthus5/pr-title-checker@v1
 ```
 
 ## Standard

diff --git a/src/index.ts b/src/index.ts
@@ -19,7 +19,14 @@ async function run() {
 
     const titleRegex = new RegExp(core.getInput('pattern'));
     if (!titleRegex.test(titleToCheck)) {
-      core.setFailed(`pull request title or latest commit message does not conform to the standard. Please use the format: <type>(<scope>): <subject>\n\nthe <type> can be: feat, fix, docs, style, refactor, test, pref, build, ci, chore or revert`);
+      core.setFailed(
+        "Pull request title or latest commit message does not conform to the standard. " +
+        "Please use the format: <type>(<scope>): <subject>\n\n" +
+        "The <type> can be: feat, fix, docs, style, refactor, test, pref, build, ci, chore or revert\n\n" +
+        "There must be exactly one space after the colon, and no space is allowed at the end of the title.\n\n" +
+        "Only displayable ASCII characters are allowed in the title. " +
+        "The displayable character number range is 32-126 (0x20-0x7E), a total of 95 characters"
+      );
     } else {
       core.info(`pull request title or latest commit message conforms to the standard`);
     }