Skip to content

ci: isolate docs-only changes from runtime test suites#103

Open
TrueAlpha-spiral wants to merge 3 commits into
mainfrom
chore/docs-only-ci-path-filters
Open

ci: isolate docs-only changes from runtime test suites#103
TrueAlpha-spiral wants to merge 3 commits into
mainfrom
chore/docs-only-ci-path-filters

Conversation

@TrueAlpha-spiral
Copy link
Copy Markdown
Collaborator

TLDR

Separates documentation-only changes from runtime CI/E2E execution so press releases, manifestos, and specification edits do not force the runner through npm ci and the full E2E matrix.

Dive Deeper

  • Adds paths-ignore to the main CI workflow for docs-only Markdown changes.
  • Adds paths-ignore to the E2E workflow for docs-only Markdown changes.
  • Adds a lightweight Docs Validation workflow that gives documentation PRs a scoped validation surface without invoking the Node dependency chain.

Why

The May 17 TAS/Log(OS) docs PR successfully merged, but the E2E workflow failed during dependency installation when the runner attempted an outbound DNS path to wombat-dressing-room.appspot.com and the firewall blocked it. That was an infrastructure/dependency refusal, not a document-content failure.

This patch enforces separation of concerns:

  • docs-only change → docs validation only
  • runtime/source change → full CI/E2E execution

Validation

This is a workflow-only patch. The intended validation is GitHub Actions trigger behavior:

  • A PR touching only docs/** or Markdown should run Docs Validation.
  • Full CI/E2E should remain available for source/runtime changes.

Security posture

This does not allowlist the blocked Appspot host. It preserves fail-closed behavior and reduces unnecessary exposure to dependency install paths for documentation-only changes.

@gemini-code-assist
Copy link
Copy Markdown

Note

Gemini is unable to generate a summary for this pull request due to the file types involved not being currently supported.

Copy link
Copy Markdown

@chatgpt-codex-connector chatgpt-codex-connector Bot left a comment

Choose a reason for hiding this comment

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

💡 Codex Review

Here are some automated review suggestions for this pull request.

Reviewed commit: 66520fd6f1

ℹ️ About Codex in GitHub

Your team has set up Codex to review pull requests in this repo. Reviews are triggered when you

  • Open a pull request for review
  • Mark a draft as ready
  • Comment "@codex review".

If Codex has suggestions, it will comment; otherwise it will react with 👍.

Codex can also answer questions or update the PR. Try commenting "@codex address that feedback".

Comment thread .github/workflows/ci.yml
Comment on lines +13 to +15
paths-ignore:
- 'docs/**'
- '**/*.md'
Copy link
Copy Markdown

Choose a reason for hiding this comment

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

P1 Badge Avoid paths-ignore on required CI workflows

This paths-ignore filter skips the entire CI workflow for docs-only pull requests, and GitHub leaves skipped required checks in Pending; if branch protection requires this workflow (or its jobs), docs-only PRs become unmergeable instead of being handled by the new docs workflow. The regression occurs whenever all changed files match docs/** or **/*.md.

Useful? React with 👍 / 👎.


on:
pull_request:
branches: [main]
Copy link
Copy Markdown

Choose a reason for hiding this comment

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

P2 Badge Include release branch in docs-validation triggers

The new docs validation workflow only listens on main, but CI now skips docs-only PRs targeting both main and release; for a docs-only PR into release, this leaves no replacement validation workflow at all, which creates an inconsistent and fragile merge path for release-branch documentation changes.

Useful? React with 👍 / 👎.

@TrueAlpha-spiral
Copy link
Copy Markdown
Collaborator Author

TrueAlpha-spiral commented May 17, 2026 via email

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant