Skip to content

Commit ad5d73b

Browse files
authored
prepare for release 0.6.1 (#541)
* update versions for release 0.6.1 * add release checklist
1 parent 5c4183c commit ad5d73b

File tree

3 files changed

+33
-1
lines changed

3 files changed

+33
-1
lines changed

CHANGELOG.md

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,8 @@
11
# Upcoming
22

3+
4+
# v0.6.1
5+
36
### Improvements
47
* Added support for Numpy 2 and h5py 3.12, and pinned PyNWB to <3.0 temporarily. [#536](https://github.com/NeurodataWithoutBorders/nwbinspector/pull/536)
58

docs/developer_guide.rst

Lines changed: 29 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -56,3 +56,32 @@ a linux system, run
5656
export NWBI_SKIP_NETWORK_TESTS=1
5757
5858
in your environment before running ``pytest``.
59+
60+
61+
Making a Release
62+
----------------
63+
64+
To prepare a release, follow these steps and make a new pull request with the changes:
65+
66+
1. Update the ``CHANGELOG.md`` header with the upcoming version number and ensure all upcoming changes are included.
67+
2. Update the version string in ``pyproject.toml``.
68+
3. Check the requirements versions and update if needed.
69+
4. Update dates in ``docs/conf.py`` and ``license.txt`` to the current year if needed.
70+
71+
After merging, follow these steps:
72+
73+
1. Create a new git tag. Pull the latest dev branch, then run the following commands (updating the release version)
74+
to create the tag and push to GitHub.
75+
76+
.. code-block::
77+
78+
release=X.Y.Z
79+
git tag ${release} --sign -m "nwbinspector ${release}"
80+
git push --tags
81+
82+
2. On the `GitHub tags <https://github.com/NeurodataWithoutBorders/nwbinspector/tags>`_ page, click "..." -> "Create release" on the new tag.
83+
Fill in the release notes from the ``CHANGELOG.md`` and publish the release.
84+
3. Publishing a release on GitHub will trigger the ``auto-publish.yml`` action on the CI that will publish the package on PyPi.
85+
4. Conda-forge maintains a bot that regularly monitors PyPi for new releases of packages that are also on conda-forge.
86+
When a new release is detected, the bot will create a pull request. Follow the instructions in that pull request to update any requirements.
87+
Once the PR is approved and merged, a new release will be published on conda-forge.

pyproject.toml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@ build-backend = "hatchling.build"
44

55
[project]
66
name = "nwbinspector"
7-
version = "0.6.0"
7+
version = "0.6.1"
88
description = "Tool to inspect NWB files for best practices compliance."
99
readme = "README.md"
1010
authors = [

0 commit comments

Comments
 (0)