Skip to content

Commit

Permalink
Document steps to release new versions
Browse files Browse the repository at this point in the history
  • Loading branch information
davidalber committed Jan 27, 2024
1 parent 4095f9f commit 2682e90
Showing 1 changed file with 13 additions and 0 deletions.
13 changes: 13 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -38,3 +38,16 @@ Several development commands are runnable with `make`:
- `make check` does code formatting (checking, not modifying),
linting, type checking, and testing in one command; if this command
does not pass, CI will not pass

## Releasing New Versions

1. Increase the version in pyproject.toml.
1. Add an entry for the new version in CHANGELOG.md.
1. Tag the new version.
```bash
$ git tag -s vVERSION COMMIT_SHA
```
1. Build the distribution.
```bash
$ poetry build
```

0 comments on commit 2682e90

Please sign in to comment.