Release v0.7.0 checklist

[matthewfeickert]

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.
  • c.f. PR docs: Add v0.7.0 release notes #1705
• Verify that the release notes files correctly summarize all development changes since the last release.
• Draft email to pyhf-announcements mailing 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_TEMPLATE directory if there are revisions.
  • c.f. PR docs: Update release checklist notes for Conda-forge and LCG views #2021
• Make a release to TestPyPI using the workflow dispatch event trigger.
• Verify that the project README is displaying correctly on TestPyPI.
  • c.f. Issue Preferred BibTeX entry on PyPI has <s> around curly braces #2024
  • bibtex entry on PyPI/TestPyPI renders strikethrough element <s> around curly braces pypa/readme_renderer#261
• 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.
  • c.f. PR docs: Update use citations and general citations to latest distribution #2026
• Update the pypa/gh-action-pypi-publish GitHub Action used for deployment to TestPyPI and PyPI to the latest stable release.
• Update the codemeta.json file in the release PR if its requirements have updated.
  • c.f. PR chore: Update codemeta.json for scipy lower bounds #2023

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.
• 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 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.yaml match those in setup.cfg and pyproject.toml.

After Release

• Verify that the release is installable from both PyPI and Conda-forge.
• Send the drafted pyhf-announcements email out from the pyhf-announcements account email.
• Tweet the release out on both personal and team Twitter accounts.
  • c.f. https://twitter.com/pyhf_/status/1574381522836127744?s=20&t=PzWmdrA19VbF4K4U3KRsjg
• Announce the release on the Scikit-HEP community Gitter.
  • c.f. https://gitter.im/Scikit-HEP/community?at=63309eaa72ad51741ffa2c92
• Make a release for the pyhf tutorial 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.
  • c.f. feat: Bump to 0.7.0 API pyhf/pyhf-tutorial#29
• 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 pyhf available in the next LCG release.
  • c.f. the v0.6.3 request ticket as an example.
  • c.f. https://sft.its.cern.ch/jira/browse/SPI-2221
• If the release is a major or minor release, open a GitHub Release Radar Issue for the release to potentially get featured on GitHub's Release Radar blog.
• Close the release GitHub Project board.

[kratsg]

JIRA ticket for cvmfs: SPI-2221

[kratsg]

Tutorial update: pyhf/pyhf-tutorial#29

[matthewfeickert]

Tutorial update: pyhf/pyhf-tutorial#29

We need to ask them to bump the core dependencies as well.

[matthewfeickert]

Migrating all comments on revisions for the release checklist to Issue #2032.