ci: add autocorrect-lint workflow for zh-CN

[huacnlee]

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

[github-actions]

Preview URLs

• /zh-CN/docs/Web/JavaScript/Guide/Modules
• /zh-CN/docs/Web/JavaScript/Guide/Regular_Expressions

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]

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

[irvin]

@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]

@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]

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

[yin1999]

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]

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]

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

[bsmth]

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

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

[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]

• @caugner

[bsmth]

pinging @LeoMcA for another set of eyes 👀

[caugner]

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

[yin1999]

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

[huacnlee]

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

[bsmth]

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

Thanks everyone 👍🏻

[queengooborg]

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]

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.