Skip to content

Conversation

@t-b
Copy link
Collaborator

@t-b t-b commented Dec 10, 2025

GitHub

  • Assign a developer to be responsible for the release deployment
  • Create a release branch from master
  • Create a draft pull request for the release
    - [ ] Add the Project Owner as a reviewer
    • Copy this checklist into the draft pull request description
  • Prepare the official release commit
    • Move changes from the "Unreleased" section to the proper sections in the CHANGELOG.md
    • Confirm all GitHub Actions tests pass
    • Change the draft to pull request to "ready for review"
      - [ ] Code Review with the Project Owner
    • When it is ready, merge into the master branch; this will generate a merge commit, and this commit will be the official release commit.
  • Create a Release: https://github.com/AllenInstitute/ipfx/releases <"Draft a new release" button>
    • Create a draft release
    • Summarize the release notes from the CHANGELOG.md and post them on on the Releases page on GitHub
      - [ ] Review the release with the Project Owner
    • Publish the release

PyPI and BKP

  • Set release version with "git tag v#.#.#" (e.g. "git tag v1.0.0"), this triggers CI to publish ipfx to PyPI
    - [ ] Build and deploy:
    ~~ - [ ] hatch build~~
    ~~ - [ ] twine upload dist/* --verbose --config-file ~/.pypirc~~
  • Announce release on https://community.brain-map.org

@t-b t-b self-assigned this Dec 10, 2025
t-b added 2 commits December 10, 2025 17:47
We don't use it anymore and now also use github actions for releasing.
@t-b t-b force-pushed the update-changelog branch from ee207dc to 6c12d69 Compare December 10, 2025 16:47
@t-b t-b merged commit 62e612d into master Dec 10, 2025
10 checks passed
@t-b t-b deleted the update-changelog branch December 10, 2025 18:01
@t-b
Copy link
Collaborator Author

t-b commented Dec 10, 2025

This needed two more PRs #589 #590 as release CI is notoriously difficult to test.

@t-b
Copy link
Collaborator Author

t-b commented Dec 10, 2025

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants