Skip to content

Release

Release #3

Workflow file for this run

---
name: Release
on: workflow_dispatch
jobs:
build:
name: Publish a release
runs-on: ubuntu-latest
# Specifying an environment is strongly recommended by PyPI.
# See https://github.com/pypa/gh-action-pypi-publish/tree/release/v1/?tab=readme-ov-file#trusted-publishing.
environment: release
permissions:
# This is needed for PyPI publishing.
# See https://github.com/pypa/gh-action-pypi-publish/tree/release/v1/?tab=readme-ov-file#trusted-publishing.
id-token: write
# This is needed for https://github.com/stefanzweifel/git-auto-commit-action.
contents: write
strategy:
matrix:
python-version: ["3.12"]
steps:
- uses: actions/checkout@v4
with:
# See
# https://github.com/stefanzweifel/git-auto-commit-action?tab=readme-ov-file#push-to-protected-branches
token: ${{ secrets.RELEASE_PAT }}
- name: "Set up Python"
uses: actions/setup-python@v5
with:
python-version: ${{ matrix.python-version }}
- name: "Calver calculate version"
uses: StephaneBour/actions-calver@master
id: calver
with:
date_format: "%Y.%m.%d"
release: false
env:
GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
- name: "Update changelog"
uses: jacobtomlinson/gha-find-replace@v3
env:
NEXT_VERSION: ${{ steps.calver.outputs.release }}
with:
find: "Next\n----"
replace: "Next\n----\n\n${{ env.NEXT_VERSION }}\n------------"
include: "CHANGELOG.rst"
regex: false
- uses: stefanzweifel/git-auto-commit-action@v5
id: commit
with:
commit_message: Bump CHANGELOG
- name: Bump version and push tag
id: tag_version
uses: mathieudutour/[email protected]
with:
github_token: ${{ secrets.GITHUB_TOKEN }}
custom_tag: ${{ steps.calver.outputs.release }}
tag_prefix: ""
commit_sha: ${{ steps.commit.outputs.commit_hash }}
- name: Create a GitHub release
uses: ncipollo/release-action@v1
with:
tag: ${{ steps.tag_version.outputs.new_tag }}
name: Release ${{ steps.tag_version.outputs.new_tag }}
body: ${{ steps.tag_version.outputs.changelog }}
- name: Build a binary wheel and a source tarball
run: |
# Checkout the latest tag - the one we just created.
git fetch --tags
git checkout "$(git describe --tags "$(git rev-list --tags --max-count=1)")"
python -m pip install build
python -m build --sdist --wheel --outdir dist/ .
# We use PyPI trusted publishing rather than a PyPI API token.
# See https://github.com/pypa/gh-action-pypi-publish/tree/release/v1/?tab=readme-ov-file#trusted-publishing.
- name: Publish distribution 📦 to PyPI
uses: pypa/gh-action-pypi-publish@release/v1
with:
verbose: true