Releasing

This is the maintainer runbook for cutting an EELS release. For the contributor-facing explanation of the versioning scheme, see Spec Releases.

Overview

1. Choose a version number (see Spec Releases).
2. Update the version in source code.
3. Create a pull request.
4. Wait for it to get merged.
5. Create a tag.
6. Create a GitHub release.
7. Publish to PyPI.

Updating the version in source code

The version number is set in src/ethereum/__init__.py. Change it there. For example:

diff --git a/src/ethereum/__init__.py b/src/ethereum/__init__.py
index 252f2f317..8cdd89a55 100644
--- a/src/ethereum/__init__.py
+++ b/src/ethereum/__init__.py
@@ -18,7 +18,7 @@ possible, to aid in defining the behavior of Ethereum clients.
 """
 import sys

-__version__ = "1.15.0"
+__version__ = "1.16.0rc1"

 #
 #  Ensure we can reach 1024 frames of recursion

Creating the pull request

The usual: git checkout -b release-vX.Y.Z, git commit -a, and git push.

Creating the tag

[!WARNING] Do not create the tag from the HEAD branch of the pull request.

GitHub can rewrite commits when merging pull requests, and tagging the original commit will make the git history messier than necessary.

The tag name should be the letter v followed by the version number (e.g. 1.15.0rc5.post3 becomes v1.15.0rc5.post3).

To create and push the tag:

git checkout master     # Replace `master` with the pull request's base branch.
git pull
git tag -a -s v1.15.0   # Replace `v1.15.0` with the tag name from earlier.
git push origin v1.15.0 # Replace the tag name here too.

[!IMPORTANT] If git tag complains about a missing GPG/PGP key, follow this guide to generate one. It's best to add the key to your GitHub account as well.

Creating the GitHub release

Go to the release page, choose the newly created tag, and generate release notes.

Publishing to PyPI

See the Python Packaging User Guide.