| name | deploy |
| description | Create and push a version tag to publish to PyPI and create a GitHub Release through GitHub Actions |
Deploy to PyPI
When instructed to deploy, release, or publish to PyPI, follow these steps in order. GitHub Actions builds the tagged commit, publishes it with the repository's PYPI_API_TOKEN secret, and creates the GitHub Release.
1. Check for uncommitted changes and commit if necessary
// turbo
git status --short
If there are uncommitted changes:
- Run
git diff --stat and git diff to review them.
// turbo
git diff --stat
// turbo
git diff
- Write a concise, descriptive commit message summarizing only these uncommitted changes.
- Stage and commit:
// turbo
git add -A
// turbo
git commit -m "<generated commit message>"
If there are NO uncommitted changes, proceed directly to Step 2.
2. Determine the release version
Choose the exact package version to release (for example, 1.0.98). The Git tag must be v<version>, and the workflow passes <version> to the build through OK_SCRIPT_BUILD_VERSION.
3. Tag HEAD with the release version
// turbo
git tag v<version>
Replace <version> with the chosen version (e.g. 1.0.98).