Write up process to cut a new release #28
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
carver
approved these changes
Nov 16, 2018
| 1. run `$ make docs` to view the release notes locally. Make sure everything looks like it should. | ||
| 1. Once the docs look good, commit the changes. | ||
| 1. Most repos have a section in the README that describes how to use the `make release` script. It looks something like [this](https://github.com/ethereum/web3.py#release-setup). Follow those instructions. | ||
| - If something goes wrong in the middle, you'll need to: |
There was a problem hiding this comment.
Maybe add a bullet before this with a link to https://semver.org/ and an abbreviated cheat sheat:
- backwards incompatible: bump major
- new features: bump minor
- bugfix/misc only: bump patch
cutting-a-release.md
Outdated
| - If something goes wrong in the middle, you'll need to: | ||
| - Figure out what went wrong and fix that problem | ||
| - Open up the Makefile, and run all commands after the one that failed manually | ||
| 1. Test it! |
There was a problem hiding this comment.
Maybe a line or two suggesting:
- create & activate a new virtualenv
- pip install -U <released_project>
- open shell and confirm module import works, maybe check a simple feature and/or new features
cutting-a-release.md
Outdated
| - Figure out what went wrong and fix that problem | ||
| - Open up the Makefile, and run all commands after the one that failed manually | ||
| 1. Test it! | ||
| 1. Announce to the Gitter channel. Typically this announcement includes a link to the release docs. :tada: |
There was a problem hiding this comment.
Implicit in this is making sure that the RTD build succeeded. That should happen naturally when getting the deep link to this version's release notes. But maybe worth one more bullet before this to be explicit.
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.
Let me know if I got something wrong or if I am missing anything!