Skip to content

Commit

Permalink
Add tag info to publish instructions
Browse files Browse the repository at this point in the history
  • Loading branch information
tbrlpld committed Nov 29, 2023
1 parent 6ff69d7 commit 3b79152
Showing 1 changed file with 4 additions and 0 deletions.
4 changes: 4 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -315,6 +315,10 @@ To enable the use, you want to set the environment variable `VIRTUALENV_DISCOVER
This project uses the [Trusted Publisher model for PyPI releases](https://docs.pypi.org/trusted-publishers/).
This means that publishing is done through GitHub Actions when a [new release is created on GitHub](https://github.com/tbrlpld/laces/releases/new).

To create a release you need a Git tag.
The tag can either be created on the command line and pushed or in the "create release" interface on GitHub.
The tag name should be the version number prefixed with a `v` (e.g. `v0.1.0`).

Before publishing a new release, make sure to update the changelog in `CHANGELOG.md` and the version number in `laces/__init__.py`.

To manually test publishing the package, you can use `flit`.
Expand Down

0 comments on commit 3b79152

Please sign in to comment.