README-new-release.rst

How to make a new release

Version numbering

parmap version numbering is borrowed from [1].

parmap versions use the following version numbering: MAJOR.MINOR.PATCH.DEVELOPMENT.

• MAJOR, MINOR and PATCH follow the semantic versioning of libraries rules [2]:
  • MAJOR will only change when there is an incompatible API change.
  • MINOR will increase when functionality is added in a backwards-compatible way
  • PATCH will change for backwards-compatible bug fixes.
• DEVELOPMENT is only used in the git repository and is removed before official releases.

Creating a new release

This is a list of things to do before a release:

• Review the ChangeLog file and add items if necessary.
• Bump the version in pyproject.toml to a valid release version (without DEVELOPMENT). Update the release version in docs/conf.py and in the Changelog.
• Build the source distribution and the binary wheel

python3 -m pip install --user -U "pip" "wheel" "build" "twine"
python3 -m build .

• Check that there are no missing files in dist/parmap-x.y.z.tar.gz and on dist/parmap-x.y.z-py2.py3-none-any.whl.
• Check that the restructured text is valid with

twine check dist/parmap-[VERSION].tar.gz

• Commit.
• Tag the release git tag v#.#.#.
• Push the release to origin [3]: git push origin --tags.
• Check that the testsuite [4] and the documentation [5] are updated properly.
• Upload to pypi: twine upload dist/parmap-#.#.#*

• Upload to conda-forge:

  • git clone [email protected]:zeehio/parmap-feedstock.git
  • cd parmap-feedstock
  • git remote add conda-forge https://github.com/conda-forge/parmap-feedstock
  • git pull conda-forge main
  • git checkout -b parmap-new-upstream-v#.#.#

  • Edit recipe/meta.yaml

    • Change the version at the top and the sha256 hash (from https://pypi.org/project/parmap/#files)

  • git commit, git push
  • Visit https://github.com/conda-forge/parmap-feedstock and create a PR. Follow all checks and rules and merge it.
  • Wait for conda continuous integration to finish. Check that the new parmap is at https://anaconda.org/conda-forge/parmap/files

• Bump the version in pyproject.toml to a valid development version (appending .9000). Update the version and release in docs/conf.py. Commit and push.

References

[1]	http://r-pkgs.had.co.nz/release.html

[2]	http://semver.org

[3]	https://github.com/zeehio/parmap

[4]	https://github.com/zeehio/parmap/actions

[5]	https://parmap.readthedocs.org/