-
Notifications
You must be signed in to change notification settings - Fork 8.1k
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
ci: add autocorrect-lint workflow for zh-CN (#4191)
* Add AutoCorrect as CI lint for check updated files in PR. * AutoCorrect only enable for files/zh-cn and docs/zh-cn by use .autocorrectignore * Add textRules for let AutoCorrect ignore some special cases. * Update get changed files script for autocorrect-lint GitHub Action. * Update .github/workflows/autocorrect-lint.yml Co-authored-by: A1lo <[email protected]> * Update .github/workflows/autocorrect-lint.yml Co-authored-by: A1lo <[email protected]> * Update autocorrect-lint.yml * Update .autocorrectignore Adding newline suggestion Co-authored-by: Claas Augner <[email protected]> * Update .autocorrectignore * Update autocorrect-lint.yml * remove tailing space * Update autocorrect-lint.yml --------- Co-authored-by: A1lo <[email protected]> Co-authored-by: Brian Thomas Smith <[email protected]> Co-authored-by: Claas Augner <[email protected]>
- Loading branch information
1 parent
ac6d074
commit 2dac809
Showing
3 changed files
with
55 additions
and
0 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,7 @@ | ||
# AutoCorrect Link ignore rules. | ||
# https://github.com/huacnlee/autocorrect | ||
# | ||
# Like `.gitignore`, this file to tell AutoCorrect which files need to check, some need to ignore. | ||
files/ | ||
docs/ | ||
!files/zh-cn/ |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,4 @@ | ||
textRules: | ||
一二三,四五六.七八九: 0 | ||
一二三,四五六,七八九,一二三,四五六,七八九: 0 | ||
9.9亿: 0 |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,44 @@ | ||
# This workflow to use AutoCorrect tool for checking the copywriting, correct spaces and punctuations for CJK contents. | ||
# | ||
# For example: | ||
# | ||
# - incorrect: "欢迎阅读MDN文档." | ||
# - correct: "欢迎阅读 MDN 文档。" | ||
# | ||
# - incorrect: "Welcome,this is MDN Web Docs。" | ||
# - correct: "Welcome, to read MDN Web Docs." | ||
# | ||
# More details: | ||
# https://github.com/huacnlee/autocorrect | ||
name: AutoCorrect Lint | ||
on: | ||
pull_request: | ||
branches: | ||
- main | ||
|
||
jobs: | ||
lint: | ||
runs-on: ubuntu-latest | ||
|
||
steps: | ||
- uses: actions/checkout@v3 | ||
|
||
- name: Get changed files | ||
env: | ||
GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }} | ||
BASE_SHA: ${{ github.event.pull_request.base.sha }} | ||
HEAD_SHA: ${{ github.event.pull_request.head.sha }} | ||
run: | | ||
# Use the GitHub API to get the list of changed files | ||
# documenation: https://docs.github.com/rest/commits/commits#compare-two-commits | ||
DIFF_DOCUMENTS=$(gh api repos/{owner}/{repo}/compare/${{ env.BASE_SHA }}...${{ env.HEAD_SHA }} \ | ||
--jq '.files | .[] | select(.status|IN("added", "modified", "renamed", "copied", "changed")) | .filename') | ||
# filter out files that are not markdown | ||
DIFF_DOCUMENTS=$(echo "${DIFF_DOCUMENTS}" | egrep -i "^files/zh-cn/" | xargs) | ||
echo "DIFF_DOCUMENTS=${DIFF_DOCUMENTS}" >> $GITHUB_ENV | ||
- name: AutoCorrect changed content | ||
if: ${{ env.DIFF_DOCUMENTS }} | ||
uses: huacnlee/[email protected] | ||
with: | ||
args: ${{ env.DIFF_DOCUMENTS }} --lint --no-diff-bg-color |