How to release a new version of
pantsbuild.pants and its plugins.
1. Create a PGP signing key
If you already have one, you can reuse it.
You likely want to use the gpg implementation of pgp. On macOS, you can
brew install gpg. Once gpg is installed, generate a new key: https://docs.github.com/en/github/authenticating-to-github/generating-a-new-gpg-key.
Please use a password for your key!
2. Add your PGP key to GitHub.
3. Configure Git to use your PGP key.
Note: the last step is required on macOS.
4. Create a PyPI account
5. Get added to pantsbuild.pants PyPI
You can ask any of the current Owners to add you as a maintainer.
Fill in with your PyPI credentials by running:
$ cat << EOF > ~/.pypirc && chmod 600 ~/.pypirc [pypi] username: <fill me in> password: <fill me in> [server-login] username: <fill me in> password: <fill me in> EOF
Step 1: Prepare the release
The release is automated, outside of these steps:
- Removing any completed deprecations
- Changelog preparation
- CONTRIBUTOR.md updates
- Version bumping
The first three steps always happen in the
main branch, whereas the version bump happens in the relevant release branch.
For dev and
rc0 releases, the release branch is
main. For all other release candidates and stable releases, the release branch is that respective version's branch, e.g.
dev0 - set up the release series
dev0- set up the release series
- Create a new file in
src/python/pants/notes, e.g. create
- Copy the title and template over from the prior release, e.g.
- Copy the title and template over from the prior release, e.g.
- Add the new file to
dev - Check for any deprecations
dev- Check for any deprecations
Your release will fail if there are any deprecated things that should now be removed. Usually, the person who deprecated the feature should have already removed the stale code, but they may have forgotten.
To check for this, search for the version you are releasing. For example, with ripgrep, run
rg -C3 2.9.0.dev0.
If there are things that must be removed, you can either:
- Ping the person who made the deprecation to ask them to remove it.
- Remove it yourself, either in the release prep or as a precursor PR.
- Bump the removal date back by one dev release.
0c. Release candidates - cherry-pick relevant changes
Cherry-pick all changes labeled
needs-cherrypick with the relevant milestone for the stable branch, e.g. the milestone
These pull requests must have been merged into main first, so they will already be closed.
To cherry-pick, for example, from 2.9.x:
git fetch https://github.com/pantsbuild/pants 2.9.x
git checkout -b <new-branch-name> FETCH_HEAD
- Find the commit SHA by running
git log mainor looking in GitHub: https://github.com/pantsbuild/pants/commits/main.
git cherry-pick <sha>, using the SHA from the previous step.
- Open a pull request to merge into the release branch, e.g.
Do not push directly to the release branch. All changes should be added through a pull request.
After a commit has been cherry-picked, remove the
needs-cherrypick label and remove it from the release milestone.
1. Prepare the changelog
Update the release page in
src/python/pants/notes for this release series, e.g. update
main branch, run
./pants run build-support/bin/changelog.py -- --prior 2.9.0.dev0 --new 2.9.0.dev1 with the relevant versions. This will generate the headers to copy into the release notes, along with a list of all commits since the last release.
Use your best judgment when classifying commits. If you are uncertain, you can either message the author on Slack or, in your PR, add a comment for the entry to ask for input from others.
Each entry should have exactly one blank line between it. You are encouraged to fix typos and tweak PR titles for clarity to users.
Reminder: always do this against the
Even if you are preparing notes for a release candidate, always prepare the notes in a branch based on
mainand, later, target your PR to merge with
See any weird PR titles?
Sometimes, committers accidentally use the wrong title when squashing and merging because GitHub pulls the title from the commit title when there is only one commit.
If you see a vague or strange title like "fix bug", open the original PR to see if the PR title is more descriptive. If it is, please use the more descriptive title instead.
Take note of any new contributors so that you can give a shoutout in the announcement email.
rc0 - bump the
rc0- bump the
src/python/pants/VERSION to the new release, e.g. 2.9.0.dev0.
4. Post the prep to GitHub
Open a pull request on GitHub to merge into
main. Post the PR to the #development channel in Slack.
Merge once approved and green.
Watch out for any recently landed PRs
From the time you put up your release prep until you hit "merge", be careful that no one merges any commits into main.
If they do—and you're doing a dev or
rc0release—you should merge
maininto your PR and update the changelog with their changes. It's okay if the changes were internal only, but any public changes must be added to the changelog.
Once you click "merge", it is safe for people to merge changes again.
rc0 - create a new Git branch
rc0- create a new Git branch
For example, if you're releasing
2.9.0rc0, create the branch
2.9.x by running the below. Make sure you are on your release commit before doing this.
$ git checkout -b 2.9.x $ git push upstream 2.9.x
5b. release candidates - cherry-pick and bump the VERSION
- Checkout from
maininto the release branch, e.g.
- Cherry-pick the release prep using
git cherry-pick <sha>.
- Bump the
src/python/pants/VERSION, e.g. to
2.9.0rc1. Push this as a new commit directly to the release branch - you do not need to open a pull request.
Step 2: Update this docs site
dev0 - set up the new version
dev0- set up the new version
Go to the documentation dashboard. In the top left dropdown, where it says the current version, click "Manage versions". Click "Add new version" and use a "v" with the minor release number, e.g. "v2.9". Fork from the prior release. Mark this new version as public by clicking on "Is public?"
Also, update the Changelog page with the new release series at the top of the table. It's okay if there are no "highlights" yet.
Update the version in Installing Pants
Update Installing Pants to use the version you're releasing in the
Regenerate the references
On the relevant release branch, run
./pants run build-support/bin/generate_docs.py -- --sync --api-key <key> with your key from https://dash.readme.com/project/pants/v2.8/api-key.
stable releases - Update the default docsite
stablereleases - Update the default docsite
The first stable release of a branch should update the "default" version of the docsite. For example: when releasing the stable
2.9.0, the docsite would be changed to pointing from
v2.8 to pointing to
v2.9 by default.
Also, update the Changelog's "highlights" column with a link to the blog summarizing the release. See the section "Announce the release" below for more info on the blog.
Don't have edit access?
Ping someone in the #maintainers channel in Slack to be added. Alternatively, you can "Suggest edits" in the top right corner.
Step 3: Wait for CI to build the wheels
Once you have merged the
VERSION bump—which will be on
rc0 releases and the release branch for release candidates—CI will start building the wheels you need to finish the release.
Head to https://github.com/pantsbuild/pants/actions and find your relevant build. You need the "Build wheels and fs_util" jobs to pass.
Step 4: Run
First, ensure that you are on your release branch at your version bump commit.
Tip: if new commits have landed after your release commit
You can reset to your release commit by running
git reset --hard <sha>.
This will first download the pre-built wheels built in CI and will publish them to PyPI. About 2-3 minutes in, the script will prompt you for your PGP password.
We also release a Pants Pex via GitHub releases. Run this:
PANTS_PEX_RELEASE=STABLE ./build-support/bin/release.sh build-universal-pex
Then go to https://github.com/pantsbuild/pants/tags, find your release's tag, click
Edit tag, and upload the PEX located at
Step 5: Test the release
Run this script as a basic smoke test:
You should also check PyPI to ensure everything looks good. Click "Release history" to find the version you released, then click it and confirm the changelog is correct on the "Project description" page and that the
manylinux wheels show up in the "Download files" page.
Step 6: Announce the change
Announce the release to:
- the pants-devel list
- the #announce channel in Slack
Sample emails for
You can get a contributor list by running the following, where
<tag> is the tag for the prior release (eg:
./build-support/bin/contributors.sh -s <tag>
Update these templates!
Google Groups does not support markdown. You must manually create links and remove the markdown syntax.
Also, make sure that you are using the correct version everywhere. When adding a link, use "Test this link" to ensure it loads properly.
If the release series'
.dev0 has already been released, reply to that email thread for the rest of the dev releases.
Subject: [dev release] pantsbuild.pants 2.9.0.dev0 The first weekly dev release for the 2.9 series is now available [on PyPI](https://pypi.org/project/pantsbuild.pants/2.9.0.dev0/). See the changelog [here](https://github.com/pantsbuild/pants/blob/main/src/python/pants/notes/2.8.x.md). Thank you to this week's contributors: 6 Eustolia Palledino 4 Ahmad Wensel 2 Rae Efird 1 Niki Fitch And a special shout-out to first-time contributor Niki Fitch, with the PR [`Upgrade Rust to 1.63 (#9441)`](https://github.com/pantsbuild/pants/pull/9441). Thank you for your contribution!
If the patch version's
rc0 has already been released, reply to that email thread for the rest of the patch's release candidates. That is, bundle
2.9.0 release candidates together, and
2.8.1 candidates together, etc.
Subject: [release candidate] pantsbuild.pants 2.9.0rc1 The second release candidate for 2.9.0 is now available [on PyPI](https://pypi.org/project/pantsbuild.pants/2.9.0rc1/). See the changelog [here](https://github.com/pantsbuild/pants/blob/main/src/python/pants/notes/2.9.x.md). Thank you to everyone who tested the previous release, and thank you to the folks who contributed patches! 3 Niki Fitch 1 Mario Rozell
For the first stable release in the series, first, write a blog post to summarize the series using https://pants.ghost.io/ghost/#/site. Please coordinate by posting to #development in Slack. If writing is not your thing, you can ask in #maintainers or #development if another Pants contributor would be willing to write the blog.
Subject: [stable release] pantsbuild.pants 2.9.0 The first stable release of the 2.9 series is now available [on PyPI](https://pypi.org/project/pantsbuild.pants/2.9.0/). See our [blog post](https://blog.pantsbuild.org/introducing-pants-build-2-9-0/) summarizing the release series, or the more detailed changelog [here](https://github.com/pantsbuild/pants/blob/main/src/python/pants/notes/2.9.x.md). Thanks to all of the contributors to the 2.9 series! Eustolia Palledino Ahmad Wensel Rae Efird Niki Fitch Mario Rozell
Updated over 1 year ago