Skip to content

chore(CI-CD): make version bump optional for README-only changes - #55

Merged
baxyz merged 1 commit into
mainfrom
chore/readme-only-version-bump-optional
Aug 9, 2026
Merged

chore(CI-CD): make version bump optional for README-only changes#55
baxyz merged 1 commit into
mainfrom
chore/readme-only-version-bump-optional

Conversation

@baxyz

@baxyz baxyz commented Aug 8, 2026

Copy link
Copy Markdown
Contributor

Description

Follow-up to a question about why dotfiles-sync went to 1.0.8 for a README-only fix: the version-bump-check job previously required a bump for any change under src/<name>/, including doc-only tweaks — every published version ended up byte-identical in actual container behavior to the previous one except for a bundled README diff.

Now the check only requires a bump when something other than README.md changed for the touched feature. A README-only change is logged as "optional" rather than failing the job. AGENTS.md updated to match, with the reasoning for why you might still want to bump a docs-only fix (it's the only way to get it onto the published website, since release.yml's version-diff gate also triggers the docs rebuild).

Type of Change

  • Bug fix (non-breaking change that fixes an issue)
  • New feature (non-breaking change that adds functionality)
  • Breaking change (fix or feature that would cause existing functionality to change)
  • Documentation update
  • Refactoring
  • Test improvement

Related Issues

None.

How Has This Been Tested?

  • js-yaml parse of the workflow file
  • Reproduced the check's bash logic locally against 3 scenarios: README-only + no bump (passes), install.sh change + no bump (still fails), install.sh change + bump (passes)

Checklist

  • My code follows the code style of this project
  • I have updated the documentation accordingly
  • I have added tests for my changes
  • All new and existing tests passed locally
  • My commits follow the conventional commit format

Screenshots (if applicable)

N/A.

Additional Context

None.

🤖 Generated with Claude Code

version-bump-check previously required a bump for any change under
src/<name>/, including doc-only tweaks — every published version ended
up byte-identical in actual container behavior to the previous one
except for a bundled README diff. Now checks whether anything besides
README.md changed for the touched feature; if not, the bump is logged
as optional rather than failing the job.

Still worth bumping a README-only fix when it's safety-relevant, since
release.yml's version-diff gate is also what triggers the website docs
rebuild — an unbumped doc fix never reaches the published site. That's
a judgment call now, not enforced.

Verified locally: README-only + no bump passes, install.sh change + no
bump still fails, install.sh change + bump passes.

Co-Authored-By: Claude Sonnet 5 <noreply@anthropic.com>
@github-actions

github-actions Bot commented Aug 8, 2026

Copy link
Copy Markdown

✅ PR Validation Passed

All checks passed!


📋 Pipeline Status

Job Status
🧾 Conventional Commits passing
🔖 Version Bump passing
🧪 Feature Tests passing
🐚 ShellCheck passing

🤖 Generated by @helpers4 CI • 2026-08-08

@baxyz
baxyz merged commit 746ae3c into main Aug 9, 2026
34 checks passed
@baxyz
baxyz deleted the chore/readme-only-version-bump-optional branch August 9, 2026 16:44
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