docs(release): add versioning and releases information #4917
Conversation
There was a problem hiding this comment.
Thanks for this release process update. It looks good, it just needs a few tweaks to bring it into line with previous team decisions.
In general, we prefer to use Rust ecosystem conventions, because Zebra is a Rust project. What's here is fine for now, but we might not want to use Angular as an example in future. We might also want to discuss scope before we create the next large document, to avoid wasted effort.
It seems like this PR duplicates some explanations from the release PR template. Can you please remove any duplicate or conflicting details from the release PR template?
For example, we don't need to explain semver in both places.
Is this PR meant to close ticket #4778?
We'll need to update this README section to close that ticket:
https://github.com/ZcashFoundation/zebra#beta-releases
But since this PR is already big, we might want to do that in a separate PR.
Co-authored-by: teor <teor@riseup.net>
Co-authored-by: teor <teor@riseup.net>
|
@teor2345 suggestions applied as-is |
|
|
||
| **NOTE**: <br /> | ||
| As Zebra is in a `pre-release` state (is unstable and might not satisfy the intended compatibility requirements as denoted by its associated normal version). | ||
| The pre-release version is denoted by appending a hyphen and a series of dot separated identifiers immediately following the patch version. |
There was a problem hiding this comment.
an example could be nice here
| @@ -0,0 +1,118 @@ | |||
| # Zebra versioning and releases | |||
|
|
|||
| This document contains the practices that we follow to provide you with a leading-edge application, balanced and with stability. | |||
There was a problem hiding this comment.
seems like theres an extra "and" should this be: "provide you with a leading-edge application, balanced with stability." ?
| | Level of change | Details | | ||
| |:--- |:--- | | ||
| | Major release | Contains significant new features, and commonly correspond to network upgrades; some technical assistance may be needed during the update. When updating to a major release, you may need to follow the specific upgrade instructions provided in the release notes. | | ||
| | Minor release | Contains new smaller features. Minor releases are should be fully backward-compatible. No technical assistance is expected during update. If you want to use the new features in a minor release, you might need to follow the instructions in the release notes. | |
There was a problem hiding this comment.
Extra "are"; should read: "Minor releases should be fully backward-compatible." instead
|
|
||
| <a id="previews"></a> | ||
|
|
||
| ### Preview releases |
There was a problem hiding this comment.
I think this answers my comment above about giving an example of pre-release versioning, maybe we can link to here from there instead. e.g for an example see "Preview releases"
Motivation
Our release process and criteria needed to be updated.
Review
This is a draft PR, but it needs review in this stage before continue adding more sections or details.
Reviewer Checklist
Follow Up Work
Get feedback to make the needed changes
Review some Angular documents that might be helpful to adapt:
Fixes #4778