Skip to content

DOCS-1627 - Streamline PR checks workflow#6813

Merged
kimsauce merged 10 commits into
mainfrom
docs-spellcheck-changed-files
Jun 18, 2026
Merged

DOCS-1627 - Streamline PR checks workflow#6813
kimsauce merged 10 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
kimsauce and others added 2 commits June 16, 2026 22:54
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>

@vfalconisumo vfalconisumo left a comment

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

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

Hi. Two things I think worth addressing:

  1. The active-incident label check is a great idea, but I don't think it will actually bypass the merge-window because it runs after the merge-window check itself. I'd suggest nesting the logic for the override into the conditional used by the merge-window logic (lines 244-250), such that the flow goes:

if !siteBlockedReason, then merge window is open so return

if the context is merge_group, then if label is active_incident, bypass merge-window enforcement. else, enforce merge window

  1. Line 21 labels this job as build-and-deploy, but it doesn't actually deploy anything. A clearer name will help prevent confusion if someone has to drop into the repo for support. Maybe change line 21 to run-build-checks?

… override

Rename build-and-deploy job to run-build-checks for clarity.
Fix active-incident label check in merge_group context — payload.pull_request
is undefined there, so parse the PR number from head_ref and fetch labels via API.

Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
@kimsauce kimsauce requested a review from vfalconisumo June 17, 2026 19:31
@kimsauce kimsauce added the doc:site tech Site/tool maintenance, dependencies, updates label Jun 17, 2026
@kimsauce

Copy link
Copy Markdown
Collaborator Author

Hi. Two things I think worth addressing:

  1. The active-incident label check is a great idea, but I don't think it will actually bypass the merge-window because it runs after the merge-window check itself. I'd suggest nesting the logic for the override into the conditional used by the merge-window logic (lines 244-250), such that the flow goes:

if !siteBlockedReason, then merge window is open so return
if the context is merge_group, then if label is active_incident, bypass merge-window enforcement. else, enforce merge window

  1. Line 21 labels this job as build-and-deploy, but it doesn't actually deploy anything. A clearer name will help prevent confusion if someone has to drop into the repo for support. Maybe change line 21 to run-build-checks?

@vfalconisumo Good catches! Can you let me know what you think of the fixes?

Comment thread .github/workflows/pr.yml Outdated
@kimsauce kimsauce dismissed vfalconisumo’s stale review June 17, 2026 20:52

Applied changes

@vfalconisumo vfalconisumo left a comment

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

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

LGTM!

@kimsauce kimsauce enabled auto-merge June 17, 2026 21:31
@kimsauce kimsauce added this pull request to the merge queue Jun 17, 2026
@kimsauce kimsauce removed this pull request from the merge queue due to a manual request Jun 17, 2026
@kimsauce kimsauce added this pull request to the merge queue Jun 17, 2026
@github-merge-queue github-merge-queue Bot removed this pull request from the merge queue due to failed status checks Jun 17, 2026
@kimsauce kimsauce enabled auto-merge June 18, 2026 18:18
@kimsauce kimsauce added this pull request to the merge queue Jun 18, 2026
Merged via the queue into main with commit 880a0bb Jun 18, 2026
5 checks passed
@kimsauce kimsauce deleted the docs-spellcheck-changed-files branch June 18, 2026 20:05
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 doc:site tech Site/tool maintenance, dependencies, updates

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants