doc: add a basic release process #1080
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
Stebalien
force-pushed
the
feat/release-process
branch
from
aa0052c
to
0550396
Compare
1. A simple checklist. 2. A script to generate release notes. I'm explicitly ignoring anything like a branching model for the moment. We don't have a long RC process so that shouldn't be required (yet).
Stebalien
force-pushed
the
feat/release-process
branch
from
0550396
to
9d13654
Compare
mxinden
approved these changes
Apr 29, 2021
There was a problem hiding this comment.
This pull request looks good to me, thanks for documenting the process.
I am approving as a review was requested from my side. I am not familiar with general Golang release best practices, nor am I familiar with the go-libp2p repository architecture. With that in mind, I don't think my review should be given much weight.
| @@ -110,6 +110,10 @@ If you experience any issues migrating from gx to gomod, please [join the discus | |||
|
|
|||
| `go test ./...` will run all tests in the repo. | |||
|
|
|||
| ### Releasing | |||
|
|
|||
| Please start a release by opening a new [Libp2p Release](https://github.com/libp2p/go-libp2p/issues/new?assignees=&labels=kind/tracking&template=release.md) issue. | |||
|
(merging so I can create a release issue so we can test the process) |
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.
I'm explicitly ignoring anything like a branching model for the moment. We don't have a long RC process so that shouldn't be required (yet).