Skip to content

Commit ce702cb

Browse files
authored
Bump version to v4.2.0 and update notes on creating new releases (#497)
This is a minor change that: - Bumps the version number to 4.1.3 - Updates the notes on creating new releases After this change we will need to: - Update the [changelog](https://github.com/MIT-LCP/wfdb-python/blob/main/docs/changes.rst) - Update the [documentation](https://github.com/MIT-LCP/wfdb-python/tree/main/docs) if necessary - Create a new release at: https://github.com/MIT-LCP/wfdb-python/releases/new
2 parents ca9c7f3 + b834e0f commit ce702cb

File tree

3 files changed

+12
-2
lines changed

3 files changed

+12
-2
lines changed

DEVELOPING.md

+7-1
Original file line numberDiff line numberDiff line change
@@ -26,7 +26,13 @@ uv add <somepackage> --optional <somegroup>
2626

2727
## Creating Distributions
2828

29-
Make sure to update the version in [version.py](./wfdb/version.py) accordingly.
29+
1. Bump the version in [version.py](./wfdb/version.py).
30+
31+
2. Add a summary of the changes to [the changelog](https://github.com/MIT-LCP/wfdb-python/blob/main/docs/changes.rst). You may also need to update [the documentation](https://github.com/MIT-LCP/wfdb-python/tree/main/docs). For example, if function arguments have been updated, this change will need to be captured. Open a pull request to merge these changes to the main branch.
32+
33+
3. After the pull requests above have been merged, go to https://github.com/MIT-LCP/wfdb-python/releases and click "Draft new release" to create a new tag/release of the package. Set the tag to the new version number and draft the release notes (or click "Generate release notes"!).
34+
35+
4. Publish the project to PyPI, the [Python Package Index](https://pypi.org/project/wfdb/).
3036

3137
It may be useful to publish to testpypi and preview the changes before publishing to PyPi. However, the project dependencies likely will not be available when trying to install from there.
3238

README.md

+4
Original file line numberDiff line numberDiff line change
@@ -45,6 +45,10 @@ pip install ".[dev]"
4545

4646
Please see the [DEVELOPING.md](https://github.com/MIT-LCP/wfdb-python/blob/main/DEVELOPING.md) document for contribution/development instructions.
4747

48+
### Creating a new release
49+
50+
For guidance on creating a new release, see: https://github.com/MIT-LCP/wfdb-python/blob/main/DEVELOPING.md#creating-distributions
51+
4852
## Citing
4953

5054
When using this resource, please cite the software [publication](https://physionet.org/content/wfdb-python/) on PhysioNet.

wfdb/version.py

+1-1
Original file line numberDiff line numberDiff line change
@@ -1 +1 @@
1-
__version__ = "4.1.2"
1+
__version__ = "4.2.0"

0 commit comments

Comments
 (0)