Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Release v0.7.4 checklist #2319

Open
38 of 42 tasks
matthewfeickert opened this issue Sep 6, 2023 · 2 comments
Open
38 of 42 tasks

Release v0.7.4 checklist #2319

matthewfeickert opened this issue Sep 6, 2023 · 2 comments
Assignees
Labels
docs Documentation related

Comments

@matthewfeickert
Copy link
Member

matthewfeickert commented Sep 6, 2023

Release Checklist

Before Release

Create Release Tag

For a video walkthrough consult the pyhf v0.7.1 release recording on YouTube.

  • Use the bump version GitHub Actions workflow perform a dry run of the bump version to the new release tag.
  • Check the annotated tag in the dry run workflow logs to make sure it looks correct.
  • If the dry run passes as expected, run the same workflow with the dry run option set to false to bump the release tag version and push the new tag back to GitHub.
  • Verify the release tag was pushed to the correct branch.
  • Verify the release tag commit has bumped the correct versions.
  • Watch the CI to verify all tag based jobs finish correctly.
  • Verify the release for the tag on TestPyPI looks correct.

After Release Tag Pushed To GitHub

  • Create a GitHub release from the new release 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.
    • Create a corresponding announcement GitHub Discussion for the release.
    • c.f. v0.7.4 #2326
  • Watch the CI to ensure that the deployment to PyPI is successful.
  • Verify Docker images with the correct tags have been deployed to all container image registries.
    • Docker Hub
    • OSG Harbor (crane cp docker.io/pyhf/pyhf:v0.7.4 hub.opensciencegrid.org/pyhf/pyhf:v0.7.4)
    • CERN Harbor (crane cp docker.io/pyhf/pyhf:v0.7.4 registry.cern.ch/pyhf/pyhf:v0.7.4)
  • 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.

After Release

@matthewfeickert matthewfeickert self-assigned this Sep 6, 2023
@matthewfeickert matthewfeickert added the docs Documentation related label Sep 6, 2023
@matthewfeickert
Copy link
Member Author

matthewfeickert commented Sep 7, 2023

Issues with using environments for deployments to PyPI using v*

Screenshot from 2023-09-06 22-43-34

are coming from changes in GitHub's security covered in https://github.com/orgs/community/discussions/62991#discussioncomment-6718696

@matthewfeickert
Copy link
Member Author

matthewfeickert commented May 24, 2024

Issues with using environments for deployments to PyPI using v*

This is resolved now as the environment protection rules now apply to branches and tags

image

cc @kratsg.

This was resolved on October 3rd, 2023:

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
docs Documentation related
Projects
Status: No status
Development

No branches or pull requests

1 participant