docs: update version management system docs#30
Merged
doughayden merged 4 commits intomainfrom Jun 28, 2025
Merged
Conversation
- Rewrite complete version management documentation - Document dual-plugin system (semantic-release + poetry-dynamic-versioning) - Add comprehensive troubleshooting section - Include manual override options and emergency procedures - Update README.md to use dynamic GitHub release badge - Add configuration examples and best practices - Reference public documentation sources
doughayden
added
documentation
- Remove build artifacts from releases (upload_to_release = false) - Optimize for clone-and-use workflow vs package distribution - Add comprehensive release packaging documentation - Document 3 packaging options for future use (GitHub/PyPI/both) - Update troubleshooting for simplified configuration - Explain when to enable vs disable build artifacts
- Add version-management.md to documentation index - Update version automation description with clean releases - Reflect clone-and-use workflow optimization - Keep essential commands section current
- Fix pyproject.toml dynamic versioning config - Remove hardcoded version from [project] section - Add placeholder version to [tool.poetry] section - Set dynamic = ["version"] for proper detection - Add safe local testing guidelines - Document file modification warnings
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
What
Comprehensive update to version management documentation reflecting the current dual-plugin system implementation.
Why
The existing documentation was outdated and didn't accurately describe our current system using semantic-release + poetry-dynamic-versioning. Users need complete, accurate documentation with troubleshooting guidance.
How
docs/development/version-management.mdwith current architectureKey Improvements
Tests
Related Issues
Addresses the need for accurate documentation of the automated version management system implemented in PR #29.