ci: add autocorrect-lint workflow for zh-CN #4191

huacnlee · 2022-02-18T07:13:55Z

Continue for #3490, revert AutoCorrect again, improve CI for only check changed files.

github-actions · 2022-02-18T07:15:57Z

Preview URLs

Flaws (14)

URL: /zh-CN/docs/Web/JavaScript/Guide/Modules
Title: JavaScript 模块
Flaw count: 2

broken_links:
- Anchor not lowercase
- Is currently http:// but can become https://

URL: /zh-CN/docs/Web/JavaScript/Guide/Regular_Expressions
Title: 正则表达式
Flaw count: 12

broken_links:
- Can't resolve /zh-CN/docs/JavaScript/Reference/Global_Objects/RegExp
- Can't resolve /zh-CN/docs/Web/JavaScript/Guide/Regular_Expressions/Groups_and_Ranges
- Can't resolve /zh-CN/docs/JavaScript/Reference/Global_Objects/RegExp
- Can't resolve /zh-CN/docs/JavaScript/Reference/Global_Objects/RegExp/exec
- Can use the English (en-US) link as a fallback
- and 6 more flaws omitted
translation_differences:
- Differences in the important macros (1 in common of 2 possible)

(comment last updated: 2023-01-17 14:24:31)

huacnlee · 2022-02-18T11:37:41Z

CI example

https://github.com/huacnlee/translated-content/runs/5243996813?check_suite_focus=true

https://github.com/mdn/translated-content/runs/5244123027?check_suite_focus=true

files/zh-cn/learn/index.md

irvin · 2022-02-21T07:49:52Z

@huacnlee if i understand #3490 (comment) correctly, we should limit the lint to run only on the changed file and only if they are under /zh-cn folder, did the patch include these restrictions?

huacnlee · 2022-02-21T08:01:47Z

@huacnlee if i understand #3490 (comment) correctly, we should limit the lint to run only on the changed file and only if they are under /zh-cn folder, did the patch include these restrictions?

I think zh-tw and jp, kr need to discussion, AutoCorrect can support them, but the MDN Core team needs to consider to enable it.

huacnlee · 2022-02-21T08:09:52Z

.github/workflows/autocorrect-lint.yml

+    steps:
+      - uses: actions/checkout@v2
+        with:
+          fetch-depth: "30"


This means fetch recent 30 commits for get changed files.
In usually, a PR request commits times low that this number.

Hi @huacnlee, we just find a better solution to get changes files, could you please reflect the changes made in #10390. If you need any help from me, feel free to @ me.

translated-content/.github/workflows/pr-check_markdownlint.yml

Lines 18 to 30 in abc2a5d

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 }} \

--paginate \

--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/.*\.md$" | xargs)

echo "DIFF_DOCUMENTS=${DIFF_DOCUMENTS}" >> $GITHUB_ENV

See also:

ci(markdownlint): use GitHub API to get changed files #10390

ci(pr-test): add path filter to skip some unnecessary checks #10549

huacnlee · 2022-05-18T10:20:55Z

Hi @irvin @SphinxKnight, this Pull Request still waiting review to merge.

I just updated AutoCorrect to newest version.

For now, the CI script for detect changed files for linting looks works correct. All things done.

yin1999 · 2023-01-18T01:15:00Z

Hi @bsmth would you like to have a look on this?

bsmth · 2023-02-03T09:09:20Z

Hi @bsmth would you like to have a look on this?

Hi @yin1999, sorry for the late reply. Taking a look 👀

.github/workflows/autocorrect-lint.yml

bsmth

I don't have objections to adding this so I'm leaving a +1. Maybe @caugner would like to have a look? 👀

See my comment about sharing the duplication in the shared workflows repo for future improvement. 👍🏻

SphinxKnight · 2023-05-03T06:27:15Z

@caugner

bsmth · 2023-05-03T15:56:05Z

pinging @LeoMcA for another set of eyes 👀

caugner

LGTM, but let's add some more comments to provide context.

.autocorrectignore

.github/workflows/autocorrect-lint.yml

yin1999 · 2023-07-19T05:05:05Z

Hi @huacnlee, do you have time to take a look :)

Adding newline suggestion Co-authored-by: Claas Augner <[email protected]>

huacnlee · 2023-07-21T01:55:55Z

What can I need to do? Add the doc link?

.github/workflows/autocorrect-lint.yml

bsmth

Thanks a lot, I see all of @caugner's comments are addressed and I think we should merge.

Thanks everyone 👍🏻

queengooborg · 2023-07-27T21:45:29Z

I'm coming here after seeing CI failures in a few PRs I recently submitted to Prettier-ify the Simplified Chinese locale. I think that this was merged a little prematurely.

While the CI test is great, there's no easy way to apply the changes it is requesting. We have not added the package as a dependency, so we don't have easy access to the commands that allow us to locally test and fix reported issues. I should not have to rely on GitHub Actions to report issues in my commits; I should be able to run local, preconfigured commands to find all issues.

I will submit a follow-up PR to add the local commands and integrate this into our local workflows, once I've worked out the issues. In the meantime, I've disabled the workflow, and will re-enable it once we have set up a locally runnable command.

yin1999 · 2023-07-28T00:22:25Z

I'm coming here after seeing CI failures in a few PRs I recently submitted to Prettier-ify the Simplified Chinese locale. I think that this was merged a little prematurely.

While the CI test is great, there's no easy way to apply the changes it is requesting. We have not added the package as a dependency, so we don't have easy access to the commands that allow us to locally test and fix reported issues. I should not have to rely on GitHub Actions to report issues in my commits; I should be able to run local, preconfigured commands to find all issues.

I will submit a follow-up PR to add the local commands and integrate this into our local workflows, once I've worked out the issues. In the meantime, I've disabled the workflow, and will re-enable it once we have set up a locally runnable command.

Yes. It's a better idea to add pre-commit hook to correct the format before committing. And we may need to fix the format of all zh-CN documents again.

huacnlee requested a review from a team February 18, 2022 07:13

huacnlee requested a review from a team as a code owner February 18, 2022 07:13

huacnlee requested review from schalkneethling and t7yang and removed request for a team February 18, 2022 07:13

github-actions bot added l10n-zh Issues related to Chinese content. system Infrastructure and configuration for the project labels Feb 18, 2022

irvin requested review from irvin and SphinxKnight and removed request for t7yang February 21, 2022 07:46

irvin requested changes Feb 21, 2022

View reviewed changes

files/zh-cn/learn/index.md Outdated Show resolved Hide resolved

irvin removed request for schalkneethling and SphinxKnight February 21, 2022 07:49

huacnlee force-pushed the feat/autocorrect-lint-again branch from 7a1296a to 5bb2391 Compare February 21, 2022 08:05

github-actions bot removed the l10n-zh Issues related to Chinese content. label Feb 21, 2022

SphinxKnight self-requested a review February 21, 2022 08:06

huacnlee force-pushed the feat/autocorrect-lint-again branch from 5bb2391 to c17e7cb Compare February 21, 2022 08:07

huacnlee commented Feb 21, 2022

View reviewed changes

huacnlee force-pushed the feat/autocorrect-lint-again branch from c17e7cb to 057ebf2 Compare May 18, 2022 10:17

huacnlee mentioned this pull request May 18, 2022

AutoCorrect fix files/zh-cn/web/**/* and fix spellcheck #5726

Closed

huacnlee force-pushed the feat/autocorrect-lint-again branch from bcfa74c to f7f76ff Compare January 17, 2023 14:23

github-actions bot removed the l10n-zh Issues related to Chinese content. label Jan 17, 2023

bsmth reviewed Feb 3, 2023

View reviewed changes

.github/workflows/autocorrect-lint.yml Show resolved Hide resolved

bsmth approved these changes Feb 3, 2023

View reviewed changes

bsmth mentioned this pull request Feb 3, 2023

Add Prettier to lint command mdn/content#20674

Merged

caugner requested changes May 29, 2023

View reviewed changes

.autocorrectignore Outdated Show resolved Hide resolved

.autocorrectignore Show resolved Hide resolved

.github/workflows/autocorrect-lint.yml Outdated Show resolved Hide resolved

caugner changed the title ~~Revert to enable AutoCorrect again, and lint by git changed contents~~ ci: add autocorrect-lint workflow for zh-CN May 29, 2023

Update .autocorrectignore

5d88432

Adding newline suggestion Co-authored-by: Claas Augner <[email protected]>

huacnlee added 2 commits July 21, 2023 10:00

Update .autocorrectignore

cf049b2

Update autocorrect-lint.yml

245fa2c

yin1999 reviewed Jul 21, 2023

View reviewed changes

.github/workflows/autocorrect-lint.yml Outdated Show resolved Hide resolved

remove tailing space

143a9df

yin1999 requested a review from caugner July 21, 2023 02:15

caugner reviewed Jul 21, 2023

View reviewed changes

.github/workflows/autocorrect-lint.yml Outdated Show resolved Hide resolved

Update autocorrect-lint.yml

b6297aa

huacnlee requested a review from bsmth July 24, 2023 01:39

yin1999 requested a review from caugner July 24, 2023 01:40

bsmth approved these changes Jul 26, 2023

View reviewed changes

Merge branch 'main' into feat/autocorrect-lint-again

549b2ff

bsmth merged commit 2dac809 into mdn:main Jul 26, 2023
5 of 6 checks passed

huacnlee mentioned this pull request Jul 31, 2023

Add autocorrect-node and configure that run lint before git commit. #14773

Merged

huacnlee deleted the feat/autocorrect-lint-again branch July 31, 2023 13:51

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

ci: add autocorrect-lint workflow for zh-CN #4191

ci: add autocorrect-lint workflow for zh-CN #4191

huacnlee commented Feb 18, 2022

github-actions bot commented Feb 18, 2022 •

edited

Loading

huacnlee commented Feb 18, 2022 •

edited

Loading

irvin commented Feb 21, 2022 •

edited

Loading

huacnlee commented Feb 21, 2022 •

edited

Loading

huacnlee Feb 21, 2022

yin1999 Dec 10, 2022

huacnlee commented May 18, 2022 •

edited

Loading

yin1999 commented Jan 18, 2023

bsmth commented Feb 3, 2023

bsmth left a comment

SphinxKnight commented May 3, 2023

bsmth commented May 3, 2023

caugner left a comment

yin1999 commented Jul 19, 2023

huacnlee commented Jul 21, 2023

bsmth left a comment

queengooborg commented Jul 27, 2023 •

edited

Loading

yin1999 commented Jul 28, 2023

	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 }} \
	--paginate \
	--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/.*\.md$" \| xargs)
	echo "DIFF_DOCUMENTS=${DIFF_DOCUMENTS}" >> $GITHUB_ENV

ci: add autocorrect-lint workflow for zh-CN #4191

ci: add autocorrect-lint workflow for zh-CN #4191

Conversation

huacnlee commented Feb 18, 2022

github-actions bot commented Feb 18, 2022 • edited Loading

huacnlee commented Feb 18, 2022 • edited Loading

irvin commented Feb 21, 2022 • edited Loading

huacnlee commented Feb 21, 2022 • edited Loading

huacnlee Feb 21, 2022

Choose a reason for hiding this comment

yin1999 Dec 10, 2022

Choose a reason for hiding this comment

huacnlee commented May 18, 2022 • edited Loading

yin1999 commented Jan 18, 2023

bsmth commented Feb 3, 2023

bsmth left a comment

Choose a reason for hiding this comment

SphinxKnight commented May 3, 2023

bsmth commented May 3, 2023

caugner left a comment

Choose a reason for hiding this comment

yin1999 commented Jul 19, 2023

huacnlee commented Jul 21, 2023

bsmth left a comment

Choose a reason for hiding this comment

queengooborg commented Jul 27, 2023 • edited Loading

yin1999 commented Jul 28, 2023

github-actions bot commented Feb 18, 2022 •

edited

Loading

huacnlee commented Feb 18, 2022 •

edited

Loading

irvin commented Feb 21, 2022 •

edited

Loading

huacnlee commented Feb 21, 2022 •

edited

Loading

huacnlee commented May 18, 2022 •

edited

Loading

queengooborg commented Jul 27, 2023 •

edited

Loading