Skip to content

Latest commit

 

History

History
56 lines (33 loc) · 2.59 KB

HOW_TO_RELEASE.md

File metadata and controls

56 lines (33 loc) · 2.59 KB
Raw

Preparing a pyproj release

Preparing a pyproj release is a two-phase process.

Phase 1: Release Candidate

In this phase, we want to ensure all the builds work on all platforms and methods of distribution for the next release.

Add the rc postfix

The first step in this phase is to update the version number __version__ in __init__.py to the next release <major>.<minor>.<patch>. Then, add the rc style posfix following the PEP-440 conventions.

Create a tag on the repository

The next step is to create a tag with the same name as the version just added. This can be done using the git command line or from https://github.com/pyproj4/pyproj/tags.

Test the release builds

  1. Create a draft PR at https://github.com/pyproj4/pyproj-wheels and verify tests pass.
  2. Create a draft PR at https://github.com/conda-forge/pyproj-feedstock and verify tests pass.
  3. Check the wheels built at https://github.com/pyproj4/pyproj using GitHub Actions.
  4. Verify Debian builds were successful.
  5. Verify Fedora builds were successful.
  6. Verify the docs build successfully.

Phase 2: Make the release

After the candidate has proven itself, it will be promoted to a final release.

Remove the rc postfix

Remove the rc postfix from the the version number __version__ in __init__.py.

Create a tag on the repository

The next step is to create a tag with the name <major>.<minor>.<patch>. This can be done using the git command line or from https://github.com/pyproj4/pyproj/tags.

Next, go through the history and add release notes (see: automatically generated release notes). Make sure to acknowledge contributions made by others in the release.

The wheels

Most of the wheels are tested with each merge to main and uploaded to pypi on release in GitHub Actions. However, the arm64 wheels are built separately. This provides instructions for those wheels:

  1. linux arm64: Update the PR at https://github.com/pyproj4/pyproj-wheels with the release tag & merge. The wheels will automatically upload to pypi when the CI runs succeed.
  2. macos arm64: Download the release wheel artifacts from the Cirrus CI build and upload manually to pypi.

Verify conda-forge build is correct

A PR for pyproj will be generated automatically after you push to pypi. Verify all is correct on the PR at https://github.com/conda-forge/pyproj-feedstock.

Update the docs

On the gh-pages branch, update the stable symlink to point to the next version.