forked from mbari-org/pbp
-
Notifications
You must be signed in to change notification settings - Fork 0
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
1 changed file
with
26 additions
and
0 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
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,26 @@ | ||
# Publishing mbari-pbp | ||
|
||
The [`release-pypi.yml`](.github/workflows/release-pypi.yml) GitHub workflow | ||
takes care of the actual publishing to PyPI. | ||
|
||
We just need to proceed as follows. | ||
|
||
- Make sure all is OK in terms of code formatting, typing, testing, and linting: | ||
``` | ||
just all | ||
``` | ||
- Make sure the desired version is captured in `pyproject.toml` (under `[tool.poetry]`). | ||
- Commit the changes. | ||
- Create and push a corresponding git tag. | ||
This tag must be of the form `vX.Y.Z` for version `X.Y.Z`. | ||
- That should trigger the release workflow. | ||
--- | ||
The `tag-and-push` recipe may come in handy as it automates the extracting of the | ||
version from `pyproject.toml`, creating the tag accordingly, and pushing it. |