Skip to content

2.0.0 release #563

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.

Sign up for GitHub

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

Jump to bottom
Merged
sheriferson merged 2 commits into from
Oct 28, 2024
Merged

2.0.0 release #563

sheriferson merged 2 commits into from
Oct 28, 2024

Conversation

@sheriferson
Copy link
Contributor

@sheriferson sheriferson commented Oct 23, 2024 •
edited
Loading

GitHub

  • Assign a developer to be responsible for the release deployment
  • Create a release branch from dev
  • 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
    • Bump version in the version.txt
    • 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

  • Reconfirm the version is correct in version.txt
  • Set release version with "git tag v#.#.#" (e.g. "git tag v1.0.0", equivalent to the version you bumped to), this triggers circleci to publish ipfx to PyPI (deprecated, likely need to move to GitHub Actions)
  • After release/deployment, merge master branch (bug fixes, document generation, etc.) back into dev and delete the release branch
  • Announce release on https://community.brain-map.org

@sheriferson sheriferson marked this pull request as ready for review October 23, 2024 22:47
MatthewAitken
MatthewAitken reviewed Oct 23, 2024
View reviewed changes
RELEASE_INSTRUCTIONS.md Outdated
- [ ] Set release version with "git tag v#.#.#" (e.g. "git tag v1.0.0", equivalent to the version you bumped to), this triggers circleci to publish ipfx to pypi
- [ ] Reconfirm the version is correct in `version.txt`
- [ ] Set release version with "git tag v#.#.#" (e.g. "git tag v1.0.0", equivalent to the version you bumped to), this triggers circleci to publish ipfx to PyPI (deprecated, likely need to move to GitHub Actions)
- [ ] [Build](http://bamboo.corp.alleninstitute.org/deploy/viewDeploymentProjectEnvironments.action?id=164855841) and [Deploy](http://bamboo.corp.alleninstitute.org/deploy/viewDeploymentProjectEnvironments.action?id=164855841) IPFX Nightly
Copy link
Member

@MatthewAitken MatthewAitken Oct 23, 2024

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Is the bamboo stuff still used/done?

Copy link
Contributor Author

@sheriferson sheriferson Oct 28, 2024

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

It wasn't. I updated the instructions to mention the specific commands for now.

@sheriferson sheriferson merged commit 1ddc0e5 into master Oct 28, 2024
@sheriferson sheriferson deleted the release-2.0.0 branch October 28, 2024 21:59
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@MatthewAitken MatthewAitken MatthewAitken approved these changes

Assignees

No one assigned

Labels

None yet

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

3 participants

@sheriferson @MatthewAitken