How to make a Gammapy release#
This page contains step-by-step instructions how to make a Gammapy release. We mostly follow the Astropy release instructions and just lists the additional required steps.
Feature Freeze and Branching#
Releasing the first major release candidate#
A few days before the planned release candidate:
Fill the changelog
docs/release-notes/<version>.rstfor the version you are about to release.
Update the author list manually in the
Open a PR including both changes and mark it with the
backport-v<version>.xlabel. Gather feedback from the Gammapy user and dev community and finally merge and backport to the
On the day of the release candidate:
Add an entry for the release candidate like
download/index.jsonfile in the gammapy-web repo, by copying the entry for
devtag. As we do not handle release candidates nor bug fix releases for data, this still allows to fix bugs in the data during the release candidate testing.
CITATION.cffdate and version by running the
Locally create a new release candidate tag on the v1.0.x, like
v1.0rc1for Gammapy and push. For details see the Astropy release candidate instructions.
Once the tag is pushed the docs build and upload to PyPi should be triggered automatically.
Once the docs build has succeded find the
tutorials_jupyter.zipfile for the release candidate in the gammapy-docs repo and adapt the
download/index.jsonto point to it.
Update the entry for the release candidate in the Gammapy release calendar.`
Create a testing page like
Gammapy v1.0rc testing.
Advertise the release candidate and motivate developers and users to report test fails and bugs and list them on the page created before.
Releasing the final version of the major release#
Create a new release tag in the gammapy-data repo, like
Update the datasets entry in the
download/index.jsonfile in the gammapy-web repo to point to this new release tag.
Locally create a new release tag like
v1.0for Gammapy and push. For details see the
Astropy release candidate instructions, but leave out the
In the gammapy-docs repo:
Wait for the triggered docs build to finish.
stable/switcher.jsonto add the new version.
In the gammapy-web repo:
Mention the release on the front page and on the news page.
download/installfolder, copy a previous environment file file as
Adapt the dependency conda env name and versions as required in this file.
Adapt the entry in the
download/index.jsonfile to point ot the correct environment file.
tutorials_jupyter.zipfile for the new release in the gammapy-docs repo and adapt the
download/index.jsonto point to it.
Update the entry for the actual release in the Gammapy release calendar.`
Update the Gammapy conda-forge package at https://github.com/conda-forge/gammapy-feedstock
Encourage the Gammapy developers to try out the new stable version (update and run tests) via the GitHub issue for the release and wait a day or two for feedback.
Steps for the day to announce the release:
Send release announcement to the Gammapy mailing list and on Gammapy Slack.
If it’s a big release with important new features or fixes, also send the release announcement to the following mailing lists (decide on a case by case basis, if it’s relevant to the group of people):
Make sure the release milestone and issue is closed on GitHub
Update these release notes with any useful infos / steps that you learned while making the release (ideally try to script / automate the task or check, e.g. as a
Update version number in Binder
Dockerfilein gammapy-webpage repository master branch and tag the release for Binder.
Open a milestone and issue for the next release (and possibly also a milestone for the release after, so that low-priority issues can already be moved there) Find a release manager for the next release, assign the release issue to her / him, and ideally put a tentative date (to help developers plan their time for the coming weeks and months).
Start working on the next release.
Make a Bugfix release#
Add an entry for the bug-fix release like
download/index.jsonfile in the gammapy-web repo. The
datasetsentry should point to last stable version, like
v1.1. We do not provide bug-fix release for data.
Follow the instructions for a major release for the updates of CITATION.cff, the modifications in the
gammapy-webpagerepo as well as the conda builds.