Skip to content

Commit

Permalink
Expand docs on python-publish (#7)
Browse files Browse the repository at this point in the history
  • Loading branch information
antonagestam committed Aug 28, 2022
1 parent 8e325ca commit 7a11848
Showing 1 changed file with 8 additions and 1 deletion.
9 changes: 8 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,13 @@

A reusable workflow for building and publishing Python packages to PyPI.

- Builds package with [pypa/build].
- Verifies release tag matches version of built wheel.
- Uploads package to PyPI with [pypa/gh-action-pypi-publish].

[pypa/build]: https://github.com/pypa/build
[pypa/gh-action-pypi-publish]: https://github.com/pypa/gh-action-pypi-publish

#### Example usage

```yaml
Expand All @@ -15,7 +22,7 @@ on:

jobs:
build-and-publish:
uses: less-action/reusables/.github/workflows/python-publish.yaml@v1
uses: less-action/reusables/.github/workflows/python-publish.yaml@v5
with:
requirements_file: "setup.py"
secrets:
Expand Down

0 comments on commit 7a11848

Please sign in to comment.