diff --git a/DEVELOPING.md b/DEVELOPING.md index af77d3d..cf3ec53 100644 --- a/DEVELOPING.md +++ b/DEVELOPING.md @@ -26,7 +26,13 @@ uv add --optional ## Creating Distributions -Make sure to update the version in [version.py](./wfdb/version.py) accordingly. +1. Bump the version in [version.py](./wfdb/version.py). + +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. + +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"!). + +4. Publish the project to PyPI, the [Python Package Index](https://pypi.org/project/wfdb/). 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. diff --git a/README.md b/README.md index abd5a33..d05eb73 100644 --- a/README.md +++ b/README.md @@ -45,6 +45,10 @@ pip install ".[dev]" Please see the [DEVELOPING.md](https://github.com/MIT-LCP/wfdb-python/blob/main/DEVELOPING.md) document for contribution/development instructions. +### Creating a new release + +For guidance on creating a new release, see: https://github.com/MIT-LCP/wfdb-python/blob/main/DEVELOPING.md#creating-distributions + ## Citing When using this resource, please cite the software [publication](https://physionet.org/content/wfdb-python/) on PhysioNet. diff --git a/wfdb/version.py b/wfdb/version.py index 13ffcf4..0fd7811 100644 --- a/wfdb/version.py +++ b/wfdb/version.py @@ -1 +1 @@ -__version__ = "4.1.2" +__version__ = "4.2.0"