Skip to content

Commit

Permalink
Add development guidelines describing release process
Browse files Browse the repository at this point in the history
  • Loading branch information
aiman committed Oct 9, 2024
1 parent 5d698e2 commit 8d360ec
Show file tree
Hide file tree
Showing 2 changed files with 21 additions and 0 deletions.
19 changes: 19 additions & 0 deletions DEVELOPMENT.md
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.
2 changes: 2 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,6 +9,8 @@ This package provides typed wrappers around the Autonity-specific extensions of
Ethereum, using the [Web3.py](https://github.com/ethereum/web3.py) framework,
for convenient and statically checked interactions with the Autonity network.

This package follows [Semantic Versioning](https://semver.org/).

## Installation

```console
Expand Down

0 comments on commit 8d360ec

Please sign in to comment.