This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
name: Publish Python 🐍 distribution 📦 to PyPI and TestPyPI | ||
on: | ||
push: | ||
branches: [main] | ||
tags: ['v*'] # Only run on version tags | ||
pull_request: | ||
branches: [main] | ||
jobs: | ||
build: | ||
name: Build distribution 📦 | ||
runs-on: ubuntu-latest | ||
steps: | ||
- uses: actions/checkout@v4 | ||
- name: Set up Python | ||
uses: actions/setup-python@v5 | ||
with: | ||
python-version: "3.x" | ||
cache: 'pip' # Enable pip caching | ||
- name: Install dependencies | ||
run: | | ||
python -m pip install --upgrade pip | ||
pip install build wheel | ||
- name: Build a binary wheel and a source tarball | ||
run: python -m build | ||
- name: Store the distribution packages | ||
uses: actions/upload-artifact@v4 | ||
with: | ||
name: python-package-distributions | ||
path: dist/ | ||
retention-days: 7 # Set a reasonable retention period | ||
publish-to-testpypi: | ||
name: Publish to TestPyPI | ||
needs: [build] | ||
runs-on: ubuntu-latest | ||
if: github.event_name == 'push' && (github.ref == 'refs/heads/main' || startsWith(github.ref, 'refs/tags/')) | ||
environment: | ||
name: testpypi | ||
url: https://test.pypi.org/p/ikpykit # Update to your actual package name | ||
permissions: | ||
id-token: write | ||
steps: | ||
- name: Download artifact | ||
uses: actions/download-artifact@v4 | ||
with: | ||
name: python-package-distributions | ||
path: dist/ | ||
- name: Publish to TestPyPI | ||
uses: pypa/gh-action-pypi-publish@release/v1 | ||
with: | ||
repository-url: https://test.pypi.org/legacy/ | ||
publish-to-pypi: | ||
name: Publish to PyPI | ||
needs: [build] | ||
runs-on: ubuntu-latest | ||
if: github.event_name == 'push' && startsWith(github.ref, 'refs/tags/v') | ||
environment: | ||
name: pypi | ||
url: https://pypi.org/p/ikpykit # Update to your actual package name | ||
permissions: | ||
id-token: write | ||
steps: | ||
- name: Download artifact | ||
uses: actions/download-artifact@v4 | ||
with: | ||
name: python-package-distributions | ||
path: dist/ | ||
- name: Publish 📦 to PyPI | ||
uses: pypa/gh-action-pypi-publish@release/v1 | ||
github-release: | ||
name: Create GitHub Release | ||
needs: [publish-to-pypi] | ||
runs-on: ubuntu-latest | ||
if: github.event_name == 'push' && startsWith(github.ref, 'refs/tags/v') | ||
permissions: | ||
contents: write | ||
id-token: write | ||
steps: | ||
- name: Download artifact | ||
uses: actions/download-artifact@v4 | ||
with: | ||
name: python-package-distributions | ||
path: dist/ | ||
- name: Sign the dists with Sigstore | ||
uses: sigstore/[email protected] | ||
with: | ||
inputs: >- | ||
./dist/*.tar.gz | ||
./dist/*.whl | ||
- name: Extract release notes | ||
id: extract-release-notes | ||
run: | | ||
version=${GITHUB_REF_NAME#v} | ||
echo "version=$version" >> $GITHUB_OUTPUT | ||
- name: Create GitHub Release | ||
env: | ||
GITHUB_TOKEN: ${{ github.token }} | ||
run: | | ||
gh release create "$GITHUB_REF_NAME" \ | ||
--repo "$GITHUB_REPOSITORY" \ | ||
--title "Release $GITHUB_REF_NAME" \ | ||
--notes "Release $GITHUB_REF_NAME" | ||
- name: Upload artifacts to GitHub Release | ||
env: | ||
GITHUB_TOKEN: ${{ github.token }} | ||
run: gh release upload "$GITHUB_REF_NAME" dist/** --repo "$GITHUB_REPOSITORY" |