Skip to content

Commit

Permalink
Update notes on creating new releases.
Browse files Browse the repository at this point in the history
  • Loading branch information
tompollard committed Jul 3, 2024
1 parent 0353247 commit d2df887
Show file tree
Hide file tree
Showing 2 changed files with 11 additions and 1 deletion.
8 changes: 7 additions & 1 deletion DEVELOPING.md
Original file line number Diff line number Diff line change
Expand Up @@ -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 new 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.

Expand Down
4 changes: 4 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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.

0 comments on commit d2df887

Please sign in to comment.