Skip to content

Conversation

@mairas
Copy link
Contributor

@mairas mairas commented Jan 1, 2026

Summary

  • Remove incorrect manual git add/git commit instructions from version bump workflow
  • bumpversion is configured with commit = True, so it automatically creates the commit
  • Only git push is needed after bumping
  • Add note explaining the auto-commit behavior and clean working directory requirement

Fixes #178

Test plan

  • Verify .bumpversion.cfg has commit = True
  • Documentation is clear and matches actual workflow

🤖 Generated with Claude Code

Remove incorrect manual git add/commit instructions.
bumpversion is configured with commit=True, so it
automatically creates the commit. Only push is needed
after bumping.

Fixes #178

🤖 Generated with [Claude Code](https://claude.com/claude-code)

Co-Authored-By: Claude Opus 4.5 <noreply@anthropic.com>
@mairas
Copy link
Contributor Author

mairas commented Jan 1, 2026

PR Review: docs: fix version bump workflow documentation

Summary

This is a straightforward documentation fix that correctly removes misleading manual git add/commit instructions. The change aligns the documentation with the actual bumpversion configuration.

Verification

I verified the core claim of this PR:

  • Confirmed .bumpversion.cfg has commit = True configured
  • The existing documentation incorrectly instructed users to manually run git add and git commit, which would fail (or create duplicate commits) since bumpversion already handles this

Review of Changes

File: CLAUDE.md

The change:

  1. Removes the incorrect git add and git commit lines
  2. Changes the comment to "Push the automatically created commit"
  3. Adds an explanatory note about clean working directory requirement and auto-commit behavior

All changes are correct and improve clarity.

Minor Observations

  1. Consistent with other repos: I noticed the cockpit-apt repository's AGENTS.md already has the correct documentation pattern (the one this PR is implementing). This suggests this fix brings container-packaging-tools in line with the established pattern.

  2. Issue docs: fix version bump workflow documentation #178 remains open: The PR description says "Fixes docs: fix version bump workflow documentation #178" which should auto-close the issue on merge. Just confirming this is intentional.

Positive Notes

  • Clean, focused change that addresses exactly one issue
  • Adds helpful context about the clean working directory requirement
  • Properly references the issue it fixes
  • CI checks are passing

Verdict

Approve - This is a correct and well-scoped documentation fix. Ready to merge.

@mairas mairas merged commit 53857be into main Jan 1, 2026
2 checks passed
@mairas mairas deleted the docs/fix-version-bump-workflow branch January 1, 2026 15:54
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.

docs: fix version bump workflow documentation

2 participants