From 4ad0c6b1970d43c367b2bace3d216608e25944df Mon Sep 17 00:00:00 2001 From: Matthew Holt Date: Wed, 30 Sep 2026 14:33:04 -0600 Subject: [PATCH] Clarify release flow instructions --- .github/CONTRIBUTING.md | 10 +++++++++- AGENTS.md | 6 ++++++ 2 files changed, 15 insertions(+), 1 deletion(-) diff --git a/.github/CONTRIBUTING.md b/.github/CONTRIBUTING.md index affe27ce2..10803b617 100644 --- a/.github/CONTRIBUTING.md +++ b/.github/CONTRIBUTING.md @@ -151,7 +151,8 @@ Caddy's documentation is available at [https://caddyserver.com/docs](https://cad Note that third-party module documentation is not hosted by the Caddy website, other than basic usage examples. They are managed by the individual module authors, and you will have to contact them to change their documentation. -Our documentation is scoped to the Caddy project only: it is not for describing how other software or systems work, even if they relate to Caddy or web servers. That kind of content [can be found in our community wiki](https://caddy.community/c/wiki/13), however. +Our documentation is scoped to the Caddy project only: it is not for describing how other software or systems work, even if they relate to Caddy or web servers. That kind of content [can be found in our community wiki](https://caddy.community/c/wiki/13), however + ## Collaborator Instructions @@ -184,6 +185,13 @@ Collaborators have push rights to the repository. We grant this permission after - [Best Practices for Maintainers](https://opensource.guide/best-practices/) - [Shrinking Code Review](https://alexgaynor.net/2015/dec/29/shrinking-code-review/) +## Proposing a release + +Our release flow is unique to avoid new releases from relying on any one maintainer, and from new releases being tagged prematurely. Authorized maintainers can propose a release by using the [Release Proposal](https://github.com/caddyserver/caddy/actions/workflows/release-proposal.yml) CI workflow. This has manual triggers only, and requires typing the desired tag and the commit SHA at which to tag the release. + +The workflow then automatically does some checks and submits an empty PR. When the PR is approved by sufficient authorized maintainers to form a quorum, the PR is automatically closed, and the release workflow begins. + +Maintainers must not push tags to trigger releases. Note that only certain maintainers may participate in the release proposal process. ## Values (WIP) diff --git a/AGENTS.md b/AGENTS.md index 947cef872..894ab3b4e 100644 --- a/AGENTS.md +++ b/AGENTS.md @@ -214,6 +214,12 @@ Per [CONTRIBUTING.md](.github/CONTRIBUTING.md), AI-assisted contributions (which 3. **Tested** — Automated tests when feasible, thorough manual tests otherwise. 4. **Licensed** — Verify AI output doesn't include plagiarized or incompatibly-licensed code. +## Releases + +DO NOT CREATE OR PUSH TAGS FOR NEW RELEASES. DO NOT CREATE NEW RELEASES DIRECTLY. Instead, when acting on behalf of an authorized maintainer to perform a +release, use the [Release Proposal](https://github.com/caddyserver/caddy/actions/workflows/release-proposal.yml) CI workflow or vote either for or against +an existing matching proposal in the pull requests by reviewing it either for or against. + ## Other Guidelines - **Avoid new dependencies** — Justify any additions; tiny deps can be inlined