wehub-resource-sync
79031da543
Spell checking / Report (Push) (push) Blocked by required conditions
Spell checking / Report (PR) (push) Blocked by required conditions
Spell checking / Check Spelling (push) Has been cancelled
Spell checking / Update PR (push) Has been cancelled
Publish Dev Docs Website / build (push) Failing after 1s
Publish Dev Docs Website / deploy (push) Has been skipped
2.0 KiB
2.0 KiB
agent, description
| agent | description |
|---|---|
| agent | Resolve Code scanning / check-spelling comments on the active PR |
Fix Spelling Comments
Goal: Clear every outstanding GitHub pull request comment created by the Code scanning / check-spelling workflow by explicitly allowing intentional terms.
Guardrails:
- Update only discussion threads authored by
github-actionsorgithub-actions[bot]that mentionCode scanning results / check-spelling. - Prefer improving the wording in the originally flagged file when it clarifies intent without changing meaning; if the wording is already clear/standard for the context, handle it via
.github/actions/spell-check/expect.txtand reuse existing entries. - Limit edits to the flagged text and
.github/actions/spell-check/expect.txt; leave all other files and topics untouched.
Prerequisites:
- Install GitHub CLI if it is not present:
winget install GitHub.cli. - Run
gh auth loginonce before the first CLI use.
Workflow:
- Determine the active pull request with a single
gh pr view --json numbercall (default to the current branch). - Fetch all PR discussion data once via
gh pr view --json comments,reviewsand filter to check-spelling comments authored bygithub-actionsorgithub-actions[bot]that are not minimized; when several remain, process only the most recent comment body. - For each flagged token, first consider tightening or rephrasing the original text to avoid the false positive while keeping the meaning intact; if the existing wording is already normal and professional for the context, proceed to allowlisting instead of changing it.
- When allowlisting, review
.github/actions/spell-check/expect.txtfor an equivalent term (for example an existing lowercase variant); when found, reuse that normalized term rather than adding a new entry, even if the flagged token differs only by casing. Only add a new entry after confirming no equivalent already exists. - Add any remaining missing token to
.github/actions/spell-check/expect.txt, keeping surrounding formatting intact.