Skip to content

Commit fe627d8

Browse files
committed
Update notes on creating new releases.
1 parent 4971915 commit fe627d8

File tree

2 files changed

+11
-1
lines changed

2 files changed

+11
-1
lines changed

DEVELOPING.md

Lines changed: 7 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -29,7 +29,13 @@ The `[tool.poetry.dev-dependencies]` attribute is NOT used because of a [limitat
2929

3030
## Creating Distributions
3131

32-
Make sure the versions in [version.py](./wfdb/version.py) and [pyproject.toml](./pyproject.toml) are updated and kept in sync.
32+
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.
33+
34+
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.
35+
36+
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"!).
37+
38+
4. Publish the project to PyPI, the [Python Package Index](https://pypi.org/project/wfdb/).
3339

3440
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.
3541

README.md

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -51,6 +51,10 @@ poetry install -E dev --no-root
5151

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

54+
### Creating a new release
55+
56+
For guidance on creating a new release, see: https://github.com/MIT-LCP/wfdb-python/blob/main/DEVELOPING.md#creating-distributions
57+
5458
## Citing
5559

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

0 commit comments

Comments
 (0)