Release v0.7.1 checklist #2167
Description
Release Checklist
Before Release
- Migrate any unresolved Issues or PRs from the release GitHub project board to a new project board.
- Verify that there is a release notes file for the release under
docs/release-notes. - Verify that the release notes files correctly summarize all development changes since the last release.
- Add any new use citations or published statistical models to the Use and Citations page.
- Verify that the citations on the Use and Citations page are up to date with their current INSPIRE record.
- Draft email to
pyhf-announcementsmailing list that summarizes the main points of the release notes and circulate it for development team approval. - Update the checklist Issue template in the
.github/ISSUE_TEMPLATEdirectory if there are revisions. - Make a release to TestPyPI using the workflow dispatch event trigger.
- Verify that the project README is displaying correctly on TestPyPI.
- Update the pypa/gh-action-pypi-publish GitHub Action used for deployment to TestPyPI and PyPI to the latest stable release.
- Update the
codemeta.jsonfile in the release PR if its requirements have updated.- c.f. PR chore: Update codemeta #2173
After Release Tag Pushed To GitHub
- Create a GitHub release from the generated PR tag and copy the release notes published to the GitHub release page. The creation of the GitHub release triggers all other release related activities.
- Before pasting in the release notes copy the changes that the GitHub bot has already queued up and pasted into the tag and place them in the "Changes" section of the release notes. If the release notes are published before these are copied then they will be overwritten and you'll have to add them back in by hand.
- c.f. https://github.com/scikit-hep/pyhf/releases/tag/v0.7.1
- Watch the CI to ensure that the deployment to PyPI is successful.
- Verify there is a new Zenodo DOI minted for the release.
- Verify that the new release archive metadata on Zenodo matches is being picked up as expected from
CITATION.cff.
- Verify that the new release archive metadata on Zenodo matches is being picked up as expected from
- Verify that a Binder has properly built for the new release.
- Watch for a GitHub notification that there is an automatic PR to the Conda-forge feedstock. This may take multiple hours to happen. If there are any changes needed to the Conda-forge release make them from a personal account and not from an organization account to have workflows properly trigger.
- Check if any requirements need to be updated by commenting "@conda-grayskull show requirements" on the PR.
- Verify the requirements in the Conda-forge feedstock recipe
meta.yamlmatch those inpyproject.toml. - c.f. pyhf v0.7.1 conda-forge/pyhf-feedstock#14
After Release
- Verify that the release is installable from both PyPI and Conda-forge.
- Send the drafted
pyhf-announcementsemail out from thepyhf-announcementsaccount email. - Tweet the release out on both personal and team Twitter accounts.
- Announce the release on the Scikit-HEP community Gitter.
- Make a release for the
pyhftutorial corresponding to the previous release number. This release represents the last version of the tutorial that is guaranteed to work with previous release API. - Update the tutorial to use the new release number and API.
- Make a PR to use the new release in the CUDA enabled Docker images.
- Open a ticket on the CERN Software Process and Infrastructure JIRA to update the version of
pyhfavailable in the next LCG release.- c.f. the
v0.6.3request ticket and thev0.7.0request ticket as examples. - c.f. https://sft.its.cern.ch/jira/browse/SPI-2333
- c.f. the
- Close the release GitHub Project board.