Skip to content

Release 0.5.2

Kelvin Loh requested to merge release_0.5.3 into master

Checklist for a new release

  • Review CHANGELOG.rst and AUTHORS.rst have been updated.
  • Review deprecation warnings that can be cleaned up now.
  • CI pipelines pass
    • windows tests pass (trigger them manually!).
  • Save the pip dependencies for future reference:
    • Go to the python3.8 tests pipeline job and download the artifacts (right side "Job artifacts" --> "Download").
    • Unzip, get the frozen-requirements.txt.
    • Edit the frozen-requirements.txt file to remove gitlab-ci-token in the file.
    • Move it to frozen_requirements directory.
    • Rename and add the file for tracking. git add ./frozen_requirements/frozen-requirements-$NEW_TAG.txt
    • Commit and push. git commit -m "Add pip frozen requirements for $NEW_TAG"
    • Rename it, commit & push (only works after we've merged and created the tag):
NEW_TAG=$(git describe --tags --abbrev=0)
echo $NEW_TAG
mv frozen-requirements.txt frozen-requirements-$NEW_TAG.txt
git add ./frozen_requirements/frozen-requirements-$NEW_TAG.txt
git commit -m "Add pip frozen requirements for $NEW_TAG"
  • Bump version and push new tag:
    • Future TODO: finish automation of this step in .gitlab-ci.yml.
# Version bump
VERSION_PART=patch # or minor, or major
bump2version $VERSION_PART --config-file setup.cfg
git push --follow-tags
  • "Activate" the RTD docs build for the new tag over here.

    • Configuration:
      • Active=True
      • Hidden=False
      • Privacy Level=Public
  • Change the "Default version" of the docs to the tag that was released over here.

  • Make sure the docs build.

  • Create new release on GitLab.

    • Meaningful title
    • List of highlights followed by changelog.
    • Add a few images or animated GIFs showcasing the new exciting features.
  • Test PyPi release (see also https://adriaanrol.com/posts/pypi/).

  • Release on PyPi and wait for it to become available (see also https://adriaanrol.com/posts/pypi/).

  • Post the new release in Slack (#software-for-users and #software-for-developers).

    • PS Rockets are a must! 🚀🚀🚀
  • Inform the Quantify Marketing Team.

Edited by Kelvin Loh

Merge request reports

Loading