Skip to content

docs: improve release process documentation with explicit git commands - #79

Merged
newhoggy merged 1 commit into
mainfrom
newhoggy/release-docs
Oct 15, 2025
Merged

newhoggy merged 1 commit into
mainfrom
newhoggy/release-docs

Conversation

@newhoggy

Copy link
Copy Markdown
Member

Pull Request

Description

This PR improves the release process documentation in the README by adding explicit git commands and clarifying the automation steps. The changes make it easier for maintainers to follow the release workflow by providing clear, actionable commands at each step.

Type of Change

  • Documentation update

Changes Made

  • Added explicit git commit command for creating the release commit
  • Added explicit git tag creation command with proper formatting
  • Separated the git push commands into distinct steps for commit and tag
  • Clarified that CI automation triggers after pushing to main
  • Added direct link to GitHub releases page for easier access
  • Reorganized steps to show manual actions vs automated CI actions more clearly
  • Updated step numbering from 5 to 6 steps to accommodate the new commit/tag step

Testing

  • All existing tests pass
  • New tests added for new functionality
  • Manual testing performed

Additional Notes

The updated documentation now provides a clearer separation between what maintainers need to do manually (steps 1-4, 6) and what GitHub Actions handles automatically (step 5). This should reduce confusion during the release process and ensure all necessary git operations are performed correctly.

- Add explicit git commit and tag creation step
- Add explicit git push commands
- Clarify CI automation trigger
- Add direct link to GitHub releases page

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

Co-Authored-By: Claude <noreply@anthropic.com>
@newhoggy
newhoggy merged commit a2a634e into main Oct 15, 2025
9 checks passed
@newhoggy
newhoggy deleted the newhoggy/release-docs branch October 15, 2025 13:26
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