Skip to content

Skip version-bump check for documentation-only PRs#968

Merged
erikdarlingdata merged 1 commit into
devfrom
fix/skip-version-check-for-doc-only-prs
May 20, 2026
Merged

Skip version-bump check for documentation-only PRs#968
erikdarlingdata merged 1 commit into
devfrom
fix/skip-version-check-for-doc-only-prs

Conversation

@erikdarlingdata
Copy link
Copy Markdown
Owner

Summary

Documentation-only dev → main PRs (e.g. the v2.11.0 CHANGELOG correction in #967) don't bump the version, so check-version-bump failed and needed an admin override to merge — and threw a failure email each time.

This gates the version comparison on whether any non-*.md file changed, using dorny/paths-filter (already used in build.yml).

  • Code PRs — version comparison runs exactly as before.
  • Doc-only PRs — comparison steps are skipped, a "Skip notice" step runs instead, the job completes successfully.

Deliberately not using paths-ignore at the trigger level: check-version gates merges, so skipping the run entirely would leave the required check stuck pending. Keeping the workflow running and conditionally skipping the failing step means the check still reports — green — for doc-only PRs.

Note

The dev → main PR that carries this fix to main will itself still fail check-version once (it changes a workflow file, not a doc file, with no version bump) and needs one admin merge to bootstrap. Every doc-only PR after that is clean.

Test plan

  • YAML structure mirrors the existing dorny/paths-filter usage in build.yml
  • Confirm on first doc-only PR after merge that check-version reports green

🤖 Generated with Claude Code

A documentation-only dev->main PR (e.g. a CHANGELOG correction) does
not bump the version, so check-version-bump failed and required an
admin override to merge. The workflow now detects whether any non-*.md
file changed via dorny/paths-filter and only runs the version
comparison when it did. Documentation-only PRs hit a "Skip notice"
step instead, so the job still completes and the required check
reports success rather than being skipped (which would leave it stuck
pending).

Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
@erikdarlingdata erikdarlingdata merged commit 70f7724 into dev May 20, 2026
2 checks passed
@erikdarlingdata erikdarlingdata deleted the fix/skip-version-check-for-doc-only-prs branch May 20, 2026 01:46
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