-
Notifications
You must be signed in to change notification settings - Fork 8
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
Showing
4 changed files
with
24 additions
and
5 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,13 @@ | ||
# Releasing | ||
|
||
1. Determine the next version. Try to follow [semantic versioning](https://semver.org/). | ||
Our public API is described in [the README](./README.md#versioning) | ||
2. Create a branch named `release/vX.Y.Z`. | ||
3. Update: | ||
- The version in [pyproject.toml](./pyproject.toml) | ||
- The [CHANGELOG](./CHANGELOG.md) | ||
- The **pre-commit** hooks: `pre-commit autoupdate` | ||
4. Open a PR with the changes | ||
5. When the PR is merged, created a tag on `main` with that version with a `v` prefix, e.g. `vX.Y.Z`. | ||
6. Push the tag to Github, which will fire off the release workflow. | ||
7. Create a release via [the Github interface](https://github.com/gadomski/antimeridian/releases). |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters