Skip to content

Latest commit

 

History

History
87 lines (53 loc) · 1.94 KB

RELEASING.rst

File metadata and controls

87 lines (53 loc) · 1.94 KB

Releasing python-blosc

Author: Blosc Development Team
Contact: [email protected]
Date: 2020-12-22

Preliminaries

  • Make sure that the current main branch is passing the tests on Github Actions.

  • Make sure that RELEASE_NOTES.rst and ANNOUNCE.rst are up to date with the latest news in the release.

  • Check that VERSION file contains the correct number.

  • Commit the changes:

    $ git commit -a -m"Getting ready for release X.Y.Z"
    

Updating the online documentation site

  • Go to Blosc/blogsite repo and click on the Re-run all jobs button to regenerate the documentation and check that it has been correctly updated in https://www.blosc.org.

Tagging

  • Create a signed tag X.Y.Z from main. Use the next message:

    $ git tag -s vX.Y.Z -m "Tagging version X.Y.Z"
    
  • Push the tag to the github repo:

    $ git push
    $ git push --tags
    
  • Check that wheels are created and uploaded to PyPI.

Releasing on GitHub

Announcing

  • Send an announcement to the blosc, pydata list and python-announce lists. Use the ANNOUNCE.rst file as skeleton (or possibly as the definitive version).
  • Announce via Twitter and any other appropriate service such as Mastodon.

Post-release actions

  • Make sure you are in the main branch.

  • Edit VERSION in main to increment the version to the next minor one (i.e. X.Y.Z --> X.Y.(Z+1).dev0).

  • Create new headers for adding new features in RELEASE_NOTES.rst add this place-holder:

    #XXX version-specific blurb XXX#
    
  • Commit your changes with:

    $ git commit -a -m"Post X.Y.Z release actions done"
    $ git push
    

That's all folks!