-
Notifications
You must be signed in to change notification settings - Fork 14
New guide on versioning #203
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
base: main
Are you sure you want to change the base?
Conversation
Changes made to other relevant guides to reference this guide
|
@anilnatha - what do you think? I made a new recommendation for the commitizen tool in this guide, which I think can help developers use conventional commits (useful for future automated releases). Also, pointed your existing Pull Request guide's versioning section to this guide. |
|
|
||
| ## Wrapping it All Together | ||
|
|
||
| ```mermaid |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
A mermaid chart? Awesome! 🎉
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Yes! Here's a rendering for those interested:
graph TD
A[Start Project] --> B[Install Commitizen]
B --> C[Run cz init]
C --> F{Making Changes}
F --> G[cz commit]
G --> H[Push to Branch]
H --> I[Create Pull Request]
I --> J[Review Commits]
J --> K{Ready to Release?}
K -->|No| F
K -->|Yes| L[cz bump]
L --> M[Update CHANGELOG.md]
M --> N[Mark Release]
N --> P[CI/CD Pipeline]
P --> Q[Release Published]
Q --> F
nutjob4life
left a comment
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
LGTM! Nice work @anilnatha and @riverma 👍
Thanks for looking this over @nutjob4life! Appreciate your feedback and 👀 ! |
|
anilnatha
left a comment
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
These additions are awesome! Thanks for completing these additions.



Purpose
fundamentals, conventional commits, and the Commitizen tool for automated version management
Proposed Changes
/docs/guides/software-lifecycle/versioning/README.mdxslim-registry.jsonwith appropriate tags and Commitizen package assetIssues
Testing
yarn build