From 89f2a43387381c892fa1b383103ef62707f3055e Mon Sep 17 00:00:00 2001 From: Tom Pollard Date: Wed, 3 Jul 2024 17:22:22 -0400 Subject: [PATCH] Update notes on creating new releases. --- DEVELOPING.md | 8 +++++++- README.md | 4 ++++ 2 files changed, 11 insertions(+), 1 deletion(-) diff --git a/DEVELOPING.md b/DEVELOPING.md index f78508b0..2c2f853c 100644 --- a/DEVELOPING.md +++ b/DEVELOPING.md @@ -29,7 +29,13 @@ The `[tool.poetry.dev-dependencies]` attribute is NOT used because of a [limitat ## Creating Distributions -Make sure the versions in [version.py](./wfdb/version.py) and [pyproject.toml](./pyproject.toml) are updated and kept in sync. +1. Bump the versions in [version.py](./wfdb/version.py) and [pyproject.toml](./pyproject.toml). These files must be kept updated and in sync. Open a pull request to merge these changes to the main branch. + +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 564a32d8..e8e27f33 100644 --- a/README.md +++ b/README.md @@ -51,6 +51,10 @@ poetry install -E dev --no-root 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.