-
Notifications
You must be signed in to change notification settings - Fork 30
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
Update release guidelines #546
base: main
Are you sure you want to change the base?
Conversation
✅ Deploy Preview for nebari-docs ready!
To edit notification comments on pull requests, go to your Netlify site configuration. |
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.
self-review with missing items to complete
:::note | ||
Hotfix releases are rare and are only used to address critical issues that cannot wait | ||
for the next scheduled release, they are usually associated with | ||
[broken](https://conda-forge.org/docs/maintainer/updating_pkgs/#removing-broken-packages) | ||
or [yanked](https://pypi.org/help/#yanked) releases. And should be delivered as soon as possible. | ||
::: |
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.
Need to include dedicated section about broken releases, and how to proceed in each mirror
For example, the first Nebari CalVer release was `2022.10.1`. If a hotfix were needed in the same month, you would increment the `releaseNumber` by 1 to get `2022.10.2`. (_Note: This is just an illustration; this release does not actually exist._) | ||
|
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.
This needs to be rewritten since that's not how calver works
Reference Issues or PRs
What does this implement/fix?
Put a
x
in the boxes that applyTesting
Documentation
Access-centered content checklist
Text styling
H1
or#
in markdown).Non-text content
Any other comments?