Automate releases and docs deployment (#874)

Port mailsuite's tag-triggered release pipeline:

- Add release.yml: pushing a version tag runs the full CI suite
  (python-tests.yml via workflow_call), then builds the package (the tag
  must match the version in parsedmarc/constants.py, checked with
  `hatch version`), publishes to PyPI via Trusted Publishing, creates
  the GitHub Release with notes from the tag's CHANGELOG.md section and
  the built distributions attached, pushes the multi-arch Docker image,
  and deploys the Sphinx docs
- Add docs.yml: reusable docs build/deploy to GitHub Pages, also
  runnable on demand (workflow_dispatch) for documentation-only changes
  between releases
- docker.yml: add a workflow_call trigger with a push_image input, since
  a GitHub Release created with the workflow's own GITHUB_TOKEN emits no
  `release: published` event; release.yml calls it directly instead
- Remove the legacy build.sh / publish-docs.sh manual process
- AGENTS.md: CRITICAL rule that releases require explicit maintainer
  permission, plus docs for the new release flow and its one-time
  repo/PyPI configuration prerequisites
- Bump the mailsuite floor to >=2.3.0 (raises the transitive mail-parser
  floor to >=4.6.2 and cryptography to >=50.0.0)

Co-authored-by: Claude Fable 5 <noreply@anthropic.com>
This commit is contained in:
Sean Whalen
2026-08-17 18:22:12 -04:00
committed by GitHub
co-authored by Claude Fable 5
parent 7acfaa0cea
commit 400f3d319c
9 changed files with 231 additions and 56 deletions
+136
View File
@@ -0,0 +1,136 @@
name: Release
# Fires when a version tag (e.g. 10.5.0) is pushed. Publishing is gated on
# the full CI suite passing, and PyPI upload uses Trusted Publishing (OIDC),
# so no API token secret is needed.
on:
push:
tags:
- "[0-9]+.[0-9]+.[0-9]+*"
permissions:
contents: read
concurrency:
group: ${{ github.workflow }}-${{ github.ref }}
cancel-in-progress: false
jobs:
ci:
name: CI
uses: ./.github/workflows/python-tests.yml
secrets: inherit
build:
name: Build distributions
needs: ci
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v5
- name: Set up Python
uses: actions/setup-python@v6
with:
python-version: "3.13"
- name: Verify tag matches package version
run: |
python -m pip install --upgrade pip hatch
version="$(hatch version)"
if [ "$version" != "$GITHUB_REF_NAME" ]; then
echo "Tag $GITHUB_REF_NAME does not match package version ($version)" >&2
exit 1
fi
- name: Build sdist and wheel
run: |
hatch build
- name: Upload distributions
uses: actions/upload-artifact@v4
with:
name: dist
path: dist/
publish-pypi:
name: Publish to PyPI
needs: build
runs-on: ubuntu-latest
environment:
name: pypi
url: https://pypi.org/project/parsedmarc/
permissions:
id-token: write
steps:
- name: Download distributions
uses: actions/download-artifact@v4
with:
name: dist
path: dist/
- name: Publish
uses: pypa/gh-action-pypi-publish@release/v1
github-release:
name: Create GitHub release
needs: publish-pypi
runs-on: ubuntu-latest
permissions:
contents: write
steps:
- uses: actions/checkout@v5
- name: Download distributions
uses: actions/download-artifact@v4
with:
name: dist
path: dist/
- name: Extract changelog notes
run: |
awk -v ver="$GITHUB_REF_NAME" '
$0 == "## " ver {found=1; next}
/^## / && found {exit}
found {print}
' CHANGELOG.md > release-notes.md
if ! [ -s release-notes.md ]; then
echo "No CHANGELOG.md section found for $GITHUB_REF_NAME" >&2
exit 1
fi
- name: Create release
env:
GH_TOKEN: ${{ github.token }}
run: |
gh release create "$GITHUB_REF_NAME" dist/* \
--title "$GITHUB_REF_NAME" \
--notes-file release-notes.md
docker:
name: Build and push Docker image
needs: publish-pypi
# A GitHub Release created with this workflow's own GITHUB_TOKEN does not
# emit a `release: published` event to other workflows (GitHub's
# recursion-prevention rule), so docker.yml's `release: published`
# trigger never fires for the release created above. It is called
# directly here instead, right after the PyPI publish.
permissions:
contents: read
packages: write
uses: ./.github/workflows/docker.yml
with:
push_image: true
docs:
name: Publish documentation
# Gated on the publish so docs for a version that never shipped (tag
# mismatch, failed upload) don't deploy.
needs: publish-pypi
# Must cover everything docs.yml requests (contents: read at its
# workflow level) — a called workflow can't exceed the caller's grant,
# and the mismatch fails the whole run at startup.
permissions:
contents: read
pages: write
id-token: write
uses: ./.github/workflows/docs.yml