Skip to content

workflow: run keywords check weekly#21679

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

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

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 pingcap/docs#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)?

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

@qiancai qiancai added needs-cherry-pick-release-8.5 Should cherry pick this PR to release-8.5 branch. translation/from-docs This PR is translated from a PR in pingcap/docs. labels May 27, 2026
@ti-chi-bot ti-chi-bot Bot added the size/XS Denotes a PR that changes 0-9 lines, ignoring generated files. label May 27, 2026
@ti-chi-bot ti-chi-bot Bot added size/L Denotes a PR that changes 100-499 lines, ignoring generated files. and removed size/XS Denotes a PR that changes 0-9 lines, ignoring generated files. labels May 27, 2026
@qiancai qiancai requested a review from dveeden May 27, 2026 09:04
@qiancai qiancai self-assigned this May 27, 2026
@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 09:06:23.051391313 +0000 UTC m=+429453.021556374: ☑️ agreed by dveeden.

Comment thread .github/workflows/keywords.yaml Outdated
Comment thread .github/workflows/keywords.yaml Outdated
@qiancai qiancai added the lgtm label May 27, 2026
@qiancai
Copy link
Copy Markdown
Collaborator Author

qiancai commented May 27, 2026

/approve

@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
@ti-chi-bot ti-chi-bot Bot merged commit a2923ed into pingcap:master May 27, 2026
10 checks passed
@ti-chi-bot
Copy link
Copy Markdown
Member

In response to a cherrypick label: new pull request created to branch release-8.5: #21680.

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/from-docs This PR is translated from a PR in pingcap/docs.

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants