Skip to content

DOCS-1627 - Streamline PR checks workflow#6813

Open
kimsauce wants to merge 3 commits into
mainfrom
docs-spellcheck-changed-files
Open

DOCS-1627 - Streamline PR checks workflow#6813
kimsauce wants to merge 3 commits into
mainfrom
docs-spellcheck-changed-files

Conversation

@kimsauce

@kimsauce kimsauce commented Jun 17, 2026

Copy link
Copy Markdown
Collaborator

Purpose of this pull request

Streamlines the Pull Request Checks workflow with several improvements:

  • Merge window enforced at merge queue time — removed the if: github.event_name == 'pull_request' guard so the check runs during merge_group events (actual merge time), not just on PR open
  • Remove cid-redirects.json from backend change category
  • Scope link check and spellcheck to changed files only — both jobs now diff against origin/main and skip entirely when no docs files changed, instead of scanning all of docs/ on every run
  • Null-delimited file handling — uses mapfile -d '' and xargs -0 throughout for safe handling of filenames with spaces
  • Concurrency group — cancels stale in-progress runs when a new push is made, reducing queue buildup
  • fetch-depth: 0 on build checkout — required for git diff in the link check step

Select the type of change

  • Minor Changes - Typos, formatting, slight revisions
  • Update Content - Revisions, updating sections
  • New Content - New features, sections, pages, tutorials
  • Site and Tools - .clabot, version updates, maintenance, dependencies, new packages for the site (Docusaurus, Gatsby, React, etc.)

Ticket (if applicable)

https://sumologic.atlassian.net/browse/DOCS-1627

Speeds up the spellcheck job by diffing against origin/main and running
codespell only on .md/.mdx files touched by the PR. Skips the job
entirely when no docs files changed.

Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
@kimsauce kimsauce requested a review from vfalconisumo as a code owner June 17, 2026 04:51
@kimsauce kimsauce self-assigned this Jun 17, 2026
@cla-bot cla-bot Bot added the cla-signed Contributor approved, listed in .clabot file label Jun 17, 2026
@kimsauce kimsauce changed the base branch from main to docs-1627-fix-merge-window-readme June 17, 2026 04:53
@kimsauce kimsauce changed the base branch from docs-1627-fix-merge-window-readme to main June 17, 2026 04:54
…rge window

- Scope link check and spellcheck to changed docs files only (git diff
  against origin/main) — skip jobs entirely when no docs files changed
- Use null-delimited mapfile/xargs throughout for safe filename handling
- Add concurrency group to cancel stale in-progress runs on new pushes
- Add fetch-depth: 0 to build checkout for git diff support
- Remove if: github.event_name == 'pull_request' guard from merge window
  check so it enforces the window at merge_group (merge queue) time too

Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
@kimsauce kimsauce changed the title DOCS-1627 - Spellcheck only changed docs files DOCS-1627 - Streamline PR checks workflow Jun 17, 2026
CID redirect updates are low-risk content changes, not backend site
changes — no hard merge window restriction needed.

Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

cla-signed Contributor approved, listed in .clabot file

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant