Skip to content

Commit

Permalink
add PUBLISH.md
Browse files Browse the repository at this point in the history
  • Loading branch information
carueda committed Sep 20, 2024
1 parent 5c01a91 commit 2b2ca75
Showing 1 changed file with 26 additions and 0 deletions.
26 changes: 26 additions & 0 deletions PUBLISH.md
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.

0 comments on commit 2b2ca75

Please sign in to comment.