From 0f6fd6c410a9400de0363196af5541d54ca5f148 Mon Sep 17 00:00:00 2001 From: Sherif Soliman Date: Wed, 23 Oct 2024 15:28:25 -0700 Subject: [PATCH 1/2] Update change log for 2.0.0 release. --- CHANGELOG.md | 7 +++++-- 1 file changed, 5 insertions(+), 2 deletions(-) diff --git a/CHANGELOG.md b/CHANGELOG.md index 1425bb53..aa28866a 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -6,6 +6,9 @@ All notable changes to this project will be documented in this file. ### Added ### Changed + +## [2.0.0] = 2024-10-23 +Changed: - Removed Python 3.6 support - Updated dependencies and library for Python 3.9 to 3.11 support - Moved CI and testing to GitHub Actions @@ -20,11 +23,11 @@ Changed: - Updated data_set_features to use correct sweep feature extractor detection parameters based on StimulusType ## [1.0.6] = 2022-6-29 -Changed: +Changed: - Stop IPFX from caching its NWB Schemas when writing/modifying NWB files ## [1.0.5] = 2021-12-13 -Bug fixes: +Bug fixes: - Converts nwb_version attribute to string if it is in utf-8 encoded bytes. ## [1.0.4] = 2021-07-29 From 4d3246bac2a3e0309933d190c510a56e1693d20d Mon Sep 17 00:00:00 2001 From: Sherif Soliman Date: Wed, 23 Oct 2024 15:37:14 -0700 Subject: [PATCH 2/2] Minor update to release instructions. --- RELEASE_INSTRUCTIONS.md | 21 ++++++++++++--------- 1 file changed, 12 insertions(+), 9 deletions(-) diff --git a/RELEASE_INSTRUCTIONS.md b/RELEASE_INSTRUCTIONS.md index 74345637..486fad5d 100644 --- a/RELEASE_INSTRUCTIONS.md +++ b/RELEASE_INSTRUCTIONS.md @@ -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 @@ -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