Skip to content

Commit

Permalink
Minor update to release instructions.
Browse files Browse the repository at this point in the history
  • Loading branch information
sheriferson committed Oct 28, 2024
1 parent 0f6fd6c commit 4d3246b
Showing 1 changed file with 12 additions and 9 deletions.
21 changes: 12 additions & 9 deletions RELEASE_INSTRUCTIONS.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,9 @@
### When you are ready to release:
Once the development branch has acquired enough features for a release
Once the development branch has acquired enough features for a release
or a predetermined release date is approaching

## 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
Expand All @@ -10,22 +12,23 @@ or a predetermined release date is approaching
- [ ] 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.
- [ ] Confirm that this official release commit passes all continuous integration:
- [ ] [Build Plan](http://bamboo.corp.alleninstitute.org/browse/IFR-AAG)
- [ ] 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
- [ ] 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

### Publish:
### PyPI and BKP

- [ ] Bump the version in version.txt, if not bumped CI deployment to PyPi will fail
- [ ] 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
- [ ] [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
- [ ] After release/deployment, merge master branch (bug fixes, document generation, etc.) back into dev and delete the release branch
- [ ] 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, 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
- [ ] Build and deploy:
- [ ] `python setup.py sdist` and `python setup.py bdist_wheel`
- [ ] `twine upload dist/* --verbose --config-file ~/.pypirc`
- [ ] Announce release on https://community.brain-map.org

0 comments on commit 4d3246b

Please sign in to comment.