Add workflows to track outdated terms #1360
Conversation
- Add check-outdated-terms.yaml - Add post-outdated-terms-report.yaml Signed-off-by: Yunkon Kim <hermitkim1@gmail.com>
yunkon-kim
added
lang/ko
yunkon-kim
requested review from
caniszczyk,
CathPag,
JasonMorgan,
seokho-son,
iamNoah1 and
jihoon-seo
as code owners
✅ Deploy Preview for cncfglossary ready!
To edit notification comments on pull requests, go to your Netlify site settings. |
| echo "(DEBUG) Original file path: ./content/en/${FILE_NAME}" | ||
|
|
||
| # Actually compare between the old and lastest English terms and log diff in the file | ||
| git diff ${OLD_BRANCH}..${LATEST_BRANCH} -- ./content/en/${FILE_NAME} > ./outdated/${FILE_NAME} |
There was a problem hiding this comment.
what if there is no matched file name ?
(if the file name of source English file name has been changed?)
There was a problem hiding this comment.
@seokho-son thank you for this helpful question.
Based on a list of localized files, this workflow will check if the source English is outdated or not. This workflow cannot detect changing file names.
To handle this, I could use the following command.
| git diff ${OLD_BRANCH}..${LATEST_BRANCH} -- ./content/en/${FILE_NAME} > ./outdated/${FILE_NAME} | |
| git diff ${OLD_BRANCH}..${LATEST_BRANCH} -- ./content/en/ > ./outdated/20221018_changes.diff |
This command will output the entire change, not individual changes. I expect a long report will be posted, and an l10n approver must review all changes and pick out the localized ones.
Although l10n approvers work increases, this seems to be the more accurate way.
Is this an appropriate answer to your question? 😃
There was a problem hiding this comment.
@yunkon-kim
I think an error handling is enough at this phase.
If there is no matched file from English source (in ./content/en/*), this workflow may report the situation as well. (e.g., "there is no matched file for /ko/xxx.md . Need to check changed or removed source file")
There was a problem hiding this comment.
@seokho-son thanks for your opinion.
I applied your opinion and made another update commit. You can see a test result: yunkon-kim/test-on-github-actions#100
Signed-off-by: Yunkon Kim <hermitkim1@gmail.com>
There was a problem hiding this comment.
Hi @yunkon-kim
I think this PR is ready for testing. (within Korean team only)
Thanks for your hard work!!
|
PTAL @jihoon-seo |
Signed-off-by: Yunkon Kim <hermitkim1@gmail.com>
Signed-off-by: Yunkon Kim <hermitkim1@gmail.com>
Signed-off-by: Yunkon Kim hermitkim1@gmail.com
Describe your changes
This PR will add 2 workflows to check outdated terms.
The check-outdated-terms workflow has the following steps:
The post-outdated-terms-report has the following steps:
dev-kobranch.Related issue number or link (ex:
resolves #issue-number)Checklist before opening this PR (put
xin the checkboxes)git commit -s) is to affirm that commits comply DCO. If you are working locally, you could add an alias to yourgitconfigby runninggit config --global alias.ci "commit -s".