mirror of
https://github.com/domainaware/parsedmarc.git
synced 2026-08-19 21:53:18 +00:00
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:
co-authored by
Claude Fable 5
parent
7acfaa0cea
commit
400f3d319c
@@ -4,6 +4,9 @@ permissions:
|
||||
contents: read
|
||||
|
||||
on:
|
||||
# Backstop for a manually-created release: releases created by the Release
|
||||
# workflow itself never emit this event (see the workflow_call comment
|
||||
# below), so in the normal flow the push happens via workflow_call instead.
|
||||
release:
|
||||
types:
|
||||
- published
|
||||
@@ -13,6 +16,16 @@ on:
|
||||
# Allow maintainers to build/validate the multi-arch image on demand
|
||||
# (e.g. from a feature branch) without pushing anything to the registry.
|
||||
workflow_dispatch:
|
||||
# Called directly by the Release workflow, since a GitHub Release created
|
||||
# with that workflow's own GITHUB_TOKEN does not emit a `release:
|
||||
# published` event (GitHub recursion prevention), so the trigger above
|
||||
# never fires for it.
|
||||
workflow_call:
|
||||
inputs:
|
||||
push_image:
|
||||
description: "Push the built image to ghcr.io (used by the Release workflow)"
|
||||
type: boolean
|
||||
default: false
|
||||
|
||||
env:
|
||||
REGISTRY: ghcr.io
|
||||
@@ -49,10 +62,12 @@ jobs:
|
||||
type=semver,pattern={{major}}.{{minor}}
|
||||
|
||||
- name: Log in to the Container registry
|
||||
# Only authenticate when we will actually push (release). The master
|
||||
# push and workflow_dispatch runs build for validation only and must
|
||||
# never touch the registry, so they skip the login entirely.
|
||||
if: github.event_name == 'release'
|
||||
# Only authenticate when we will actually push: a published release
|
||||
# event, or the Release workflow calling this with push_image: true
|
||||
# (see the workflow_call comment above). The master push and
|
||||
# workflow_dispatch runs build for validation only and must never
|
||||
# touch the registry, so they skip the login entirely.
|
||||
if: github.event_name == 'release' || inputs.push_image == true
|
||||
uses: docker/login-action@v3
|
||||
with:
|
||||
registry: ${{ env.REGISTRY }}
|
||||
@@ -64,9 +79,10 @@ jobs:
|
||||
with:
|
||||
context: .
|
||||
platforms: linux/amd64,linux/arm64
|
||||
# Push only on a published release. Every other trigger (push to
|
||||
# Push on a published release event, or when the Release workflow
|
||||
# calls this with push_image: true. Every other trigger (push to
|
||||
# master, workflow_dispatch) builds both architectures for
|
||||
# validation but never pushes.
|
||||
push: ${{ github.event_name == 'release' }}
|
||||
tags: ${{ steps.meta.outputs.tags }}
|
||||
labels: ${{ steps.meta.outputs.labels }}
|
||||
push: ${{ github.event_name == 'release' || inputs.push_image == true }}
|
||||
tags: ${{ steps.meta.outputs.tags }}
|
||||
labels: ${{ steps.meta.outputs.labels }}
|
||||
|
||||
Reference in New Issue
Block a user