-
Notifications
You must be signed in to change notification settings - Fork 34
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
Improve semantic versioning implementation #147
base: master
Are you sure you want to change the base?
Conversation
rob-luke
commented
Jul 10, 2024
- Modified the release procedure to include roles from the governance doc (which was created after the release procedure).
- Modified the examples in the release procedure to be semantic version compliant.
- Removed the "v" from the document to create a compliant version
- Added "development" to the development version in the doc
- This also helps users understand if they are looking at a released or development version
RELEASE.md
Outdated
2. Unanimous approval is required from the steering committee. | ||
Ensure all steering committee members have explicitly given their approval as a public github comment in the issue. | ||
4. Open a pull request that makes the following modifications: |
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.
RELEASE.md
Outdated
2. Unanimous approval is required from the steering committee. | ||
Ensure all steering committee members have explicitly given their approval as a public github comment in the issue. | ||
4. Open a pull request that makes the following modifications: | ||
1. Modify the version number in the opening lines of the specification to match the version to be released (e.g., `1.0.0`). |
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.
1!
Better a)?
addressing two comments made by @Horschig
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.
I addressed the two comments made by @Horschig
The rest looks good to me
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.
Current formatting does not render properly in Github Markdown (see guidance
3. Open a pull request that makes the following modifications: | ||
1. Modify the version number in the opening lines of the specification to match the version to be released (e.g., `v1.0`). | ||
a. Modify the version number in the opening lines of the specification to match the version to be released (e.g., `1.0.0`). |
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.
Github is not parsing this markdown as a (sub-) bullet point, it appears inline in the preview text. Likely whitespace or numeral/character mix issue. This applies to all bullets below.
Does CHANGELOG also need updating @rob-luke ? |