docs/release.md: Add release documentation #1712
Merged
Conversation
This file contains 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
romanb
approved these changes
Aug 18, 2020
twittner
reviewed
Aug 18, 2020
docs/release.md
Outdated
|
|
||
| 1. Set the release date for each crate to be released in the respective | ||
| `CHANGELOG.md` by replacing `# X.Y.Z [unreleased]` with | ||
| `# X.Y.Z [yyyy-mm-dd]` and create a pull request against the rust-libp2p |
There was a problem hiding this comment.
I wonder why we insist on putting those dates in there? The version corresponds to a tag which maps to a commit which has a date. How often do people look at the date in a changelog?
There was a problem hiding this comment.
I am fine either way. I just want to be consistent across all github.com/libp2p/rust-libp2p crates. @romanb thoughts?
There was a problem hiding this comment.
I don't care about the dates in the changelogs much. That tradition was started here.
|
👍 Let's start with this. Thanks for the writeup. |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
In order to stay consistent across releases and also to enable possibly anyone with the correct access rights to release libp2p, this pull request adds a release documentation to the repository.
I have never cut a release of rust-libp2p. This documentation is based on past discussions and the git commit history. To reviewers: Please ensure this is in line with how you handled releasing for the last couple of versions.