docs: add example usage of pypi publish workflow

hotosm · Sep 28, 2023 · 55a219f · 55a219f
1 parent cbd9c9e
commit 55a219f
Showing 1 changed file with 18 additions and 0 deletions.
diff --git a/docs/pypi_publish.md b/docs/pypi_publish.md
@@ -21,3 +21,21 @@ No outputs.
 <!-- 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 }}
+```