Skip to content

Latest commit

 

History

History
57 lines (40 loc) · 1.71 KB

RELEASING.md

File metadata and controls

57 lines (40 loc) · 1.71 KB

Releasing

Releases of funcx and funcx-endpoint are always done with a single version number, even when only one package has changes.

The process is partially automated with tools to help along the way.

Prerequisites

You must have the following tools installed and available:

  • git
  • scriv
  • tox

You will also need the following credentials:

  • a configured GPG key in git in order to create signed tags
  • pypi credentials for use with twine (e.g. a token in ~/.pypirc) valid for publishing funcx and funcx-endpoint

Procedure

  1. Bump versions of both packages to a new latest version number by removing the -dev suffix
$EDITOR funcx_sdk/funcx/version.py funcx_endpoint/funcx_endpoint/version.py

  1. Update the changelog by running scriv collect --edit

  2. Add and commit the changes to version numbers and changelog files (including the removal of changelog.d/ files), e.g. as follows

git add changelog.d/ docs/changelog.rst
git add funcx_sdk/funcx/version.py funcx_endpoint/funcx_endpoint/version.py
git commit -m 'Bump versions and changelog for release'
git push

  1. Run the release script ./release.sh from the repo root. This will use tox and your pypi credentials and will create a signed release tag. At the end of this step, new packages will be published to pypi.

  2. Push the release tag, e.g. git push upstream 0.3.9

  3. Update the version numbers to the next point version and re-add the -dev suffix, then commit and push, e.g.

$EDITOR funcx_sdk/funcx/version.py funcx_endpoint/funcx_endpoint/version.py
git add funcx_sdk/funcx/version.py funcx_endpoint/funcx_endpoint/version.py
git commit -m 'Bump versions for dev'
git push