-
Notifications
You must be signed in to change notification settings - Fork 3
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Add development guidelines describing release process
- Loading branch information
Showing
2 changed files
with
21 additions
and
0 deletions.
There are no files selected for viewing
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
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,19 @@ | ||
# Development Guidelines | ||
|
||
## Release Process | ||
|
||
Prepare the release (any contributor): | ||
|
||
- [ ] _Merge the changes_. All changes must be merged into `master` so that they can have stable commit IDs, which can be referenced from the Changelog. | ||
- [ ] _Determine the next version number_. Follow the [Semantic Versioning](https://semver.org/) standard to determine the `$NEXT_VERSION` number. | ||
- [ ] _Prepare the Changelog_. Create a new `CHANGELOG.md` section following [Common Changelog](https://common-changelog.org/). Don't hard wrap lines as it is less readable in plaintext. Remember to add the Github Release link at the bottom. | ||
|
||
Make the release (maintainers only): | ||
|
||
- [ ] _Bump the version_. Run `hatch version $NEXT_VERSION` to bump the version. Commit the changes with `$NEXT_VERSION` as the commit message. | ||
- [ ] _Tag the version commit_. Tag this version bump Git commit with the version number: `git tag $NEXT_VERSION master`. | ||
- [ ] _Push the tag_. As Git tags are not pushed by default, it needs an explicit push: `git push origin $NEXT_VERSION`. | ||
- [ ] _Build the release artifacts_. Build in a clean environment by recreating it with `hatch env prune`. Then `hatch build --clean`. | ||
- [ ] _Publish to PyPI_. Push the release artifacts to the [Python Package Index](https://pypi.org/) with `hatch publish`. | ||
- [ ] _Create the Github Release_. [Create a new Github Release](https://github.com/autonity/autonity.py/releases/new). When completing the form, select the `$NEXT_VERSION` tag, add relevant content from the `CHANGELOG.md` entry, and mark this as the "latest release". | ||
- [ ] _Announce the release_. Notify relevant chat and social channels about the release. Reach out to community managers to promote it. |
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