Skip to content

workflow: run keywords check weekly#22951

Merged
ti-chi-bot[bot] merged 3 commits into
pingcap:masterfrom
qiancai:weekly-keywords-check
May 27, 2026
Merged

workflow: run keywords check weekly#22951
ti-chi-bot[bot] merged 3 commits into
pingcap:masterfrom
qiancai:weekly-keywords-check

Conversation

@qiancai
Copy link
Copy Markdown
Collaborator

@qiancai qiancai commented May 27, 2026

What is changed, added or deleted? (Required)

This PR changes the keywords check from a per-PR and push CI gate to a weekly, manually runnable, and repository-dispatch workflow.

After this change, the workflow:

  • checks keywords.md on the configured branches, currently master and release-8.5;
  • compares each docs branch with the TiDB parser branch of the same name;
  • creates an issue only when keyword mismatches are found;
  • skips parser download failures with a warning instead of reporting them as keyword mismatches;
  • normalizes check-keywords.py to return 0 for success and 1 for any number of mismatches.

This reduces unnecessary disruption to unrelated PRs. Previously, every PR could be blocked by a keywords mismatch even when the PR did not touch keywords.md or parser-related content (see #22923 (comment)). With the new behavior, keyword drift is still monitored regularly, but it is reported as a maintenance issue instead of interrupting unrelated documentation changes.

Which TiDB version(s) do your changes apply to? (Required)

  • master (the latest development version)
  • v9.0 (TiDB 9.0 versions)
  • v8.5 (TiDB 8.5 versions)
  • v8.1 (TiDB 8.1 versions)
  • v7.5 (TiDB 7.5 versions)
  • v7.1 (TiDB 7.1 versions)
  • v6.5 (TiDB 6.5 versions)
  • v6.1 (TiDB 6.1 versions)

What is the related PR or file link(s)?

  • This PR is translated from:
  • Other reference link(s):

Do your changes match any of the following descriptions?

  • Delete files
  • Change aliases
  • Need modification after applied to another branch
  • Might cause conflicts after applied to another branch

@ti-chi-bot ti-chi-bot Bot added missing-translation-status This PR does not have translation status info. size/L Denotes a PR that changes 100-499 lines, ignoring generated files. labels May 27, 2026
Copy link
Copy Markdown
Contributor

@gemini-code-assist gemini-code-assist Bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Code Review

This pull request modifies the exit status of the check-keywords.py script to return a binary status (0 or 1) instead of the raw error count. The reviewer suggested using a more idiomatic Python conditional expression 1 if errors else 0 instead of min(errors, 1) to explicitly convey this intent.

Comment thread scripts/check-keywords.py Outdated
@qiancai qiancai requested a review from dveeden May 27, 2026 07:15
@qiancai qiancai self-assigned this May 27, 2026
@qiancai qiancai changed the title run keywords check weekly workflow: run keywords check weekly May 27, 2026
Copy link
Copy Markdown
Contributor

@dveeden dveeden left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Only glanced over the changes. Looks fine to me.

@ti-chi-bot ti-chi-bot Bot added the needs-1-more-lgtm Indicates a PR needs 1 more LGTM. label May 27, 2026
@ti-chi-bot
Copy link
Copy Markdown

ti-chi-bot Bot commented May 27, 2026

[LGTM Timeline notifier]

Timeline:

  • 2026-05-27 07:19:47.458037007 +0000 UTC m=+423057.428202062: ☑️ agreed by dveeden.

@qiancai qiancai force-pushed the weekly-keywords-check branch from 4f22024 to fdc412c Compare May 27, 2026 07:24
Comment thread scripts/check-keywords.py Outdated
Comment thread .github/workflows/keywords.yaml Outdated
Comment thread .github/workflows/keywords.yaml Outdated
@qiancai
Copy link
Copy Markdown
Collaborator Author

qiancai commented May 27, 2026

/approve

@qiancai qiancai added the lgtm label May 27, 2026
@ti-chi-bot
Copy link
Copy Markdown

ti-chi-bot Bot commented May 27, 2026

[APPROVALNOTIFIER] This PR is APPROVED

This pull-request has been approved by: qiancai

The full list of commands accepted by this bot can be found here.

The pull request process is described here

Details Needs approval from an approver in each of these files:

Approvers can indicate their approval by writing /approve in a comment
Approvers can cancel approval by writing /approve cancel in a comment

@ti-chi-bot ti-chi-bot Bot added the approved label May 27, 2026
@qiancai qiancai added the translation/doing This PR's assignee is translating this PR. label May 27, 2026
@ti-chi-bot ti-chi-bot Bot removed the missing-translation-status This PR does not have translation status info. label May 27, 2026
@ti-chi-bot ti-chi-bot Bot merged commit e9f32ff into pingcap:master May 27, 2026
11 checks passed
@qiancai qiancai added the needs-cherry-pick-release-8.5 Should cherry pick this PR to release-8.5 branch. label May 27, 2026
@ti-chi-bot
Copy link
Copy Markdown
Member

In response to a cherrypick label: new pull request created to branch release-8.5: #22953.
But this PR has conflicts, please resolve them!

qiancai added a commit to qiancai/docs-cn that referenced this pull request May 27, 2026
@qiancai qiancai added translation/done This PR has been translated from English into Chinese and updated to pingcap/docs-cn in a PR. and removed translation/doing This PR's assignee is translating this PR. labels May 27, 2026
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

approved lgtm needs-1-more-lgtm Indicates a PR needs 1 more LGTM. needs-cherry-pick-release-8.5 Should cherry pick this PR to release-8.5 branch. size/L Denotes a PR that changes 100-499 lines, ignoring generated files. translation/done This PR has been translated from English into Chinese and updated to pingcap/docs-cn in a PR.

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants