Skip to content

Commit

Permalink
docs: add example usage of pypi publish workflow
Browse files Browse the repository at this point in the history
  • Loading branch information
spwoodcock committed Sep 28, 2023
1 parent cbd9c9e commit 6518233
Showing 1 changed file with 25 additions and 3 deletions.
28 changes: 25 additions & 3 deletions docs/pypi_publish.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,20 +4,42 @@

<!-- AUTO-DOC-INPUT:START - Do not remove or modify this section -->

| INPUT | TYPE | REQUIRED | DEFAULT | DESCRIPTION |
|-------------------------------------------------------------------------------------|--------|----------|---------|-------------------------------------------------------------------|
| <a name="input_token_secret_name"></a>[token_secret_name](#input_token_secret_name) | string | true | | The name of the repository <br>secret containing the PyPi token. |
| INPUT | TYPE | REQUIRED | DEFAULT | DESCRIPTION |
| ----------------------------------------------------------------------------------- | ------ | -------- | ------- | ---------------------------------------------------------------- |
| <a name="input_token_secret_name"></a>[token_secret_name](#input_token_secret_name) | string | true | | The name of the repository <br>secret containing the PyPi token. |

<!-- AUTO-DOC-INPUT:END -->

## Outputs

<!-- AUTO-DOC-OUTPUT:START - Do not remove or modify this section -->

No outputs.

<!-- AUTO-DOC-OUTPUT:END -->

## Secrets

<!-- AUTO-DOC-SECRETS:START - Do not remove or modify this section -->

No secrets.

<!-- AUTO-DOC-SECRETS:END -->

## Example Usage

```yaml
name: Publish to PyPi.org

on:
release:
types: [published]
# Allow manual trigger (workflow_dispatch)
workflow_dispatch:

jobs:
publish_to_pypi:
uses: hotosm/gh-workflows/.github/workflows/pypi_publish.yml@main
secrets:
PYPI_TOKEN: ${{ secrets.PYPI_TOKEN }}
```

0 comments on commit 6518233

Please sign in to comment.