Fast and extensible multi-platform HTTP/1-2-3 web server with automatic HTTPS
Mirrored from https://github.com/Slazee/caddy.git
Synced Nov 11, 04:45 UTC
Clarify release flow instructions
Matthew Holt committed
Sep 30, 2026 at 14:33 UTC
4ad0c6b1970d43c367b2bace3d216608e25944df
2 files changed
+15
-1
.github/CONTRIBUTING.md
+9
-1
@@ -151,7 +151,8 @@ Caddy's documentation is available at [https://caddyserver.com/docs](https://cad
151
152
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.
153
154
-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.
154
+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
155
+
156
157
## Collaborator Instructions
158
@@ -184,6 +185,13 @@ Collaborators have push rights to the repository. We grant this permission after
185
- [Best Practices for Maintainers](https://opensource.guide/best-practices/)
186
- [Shrinking Code Review](https://alexgaynor.net/2015/dec/29/shrinking-code-review/)
187
188
+## Proposing a release
189
+
190
+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.
191
+
192
+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.
193
+
194
+Maintainers must not push tags to trigger releases. Note that only certain maintainers may participate in the release proposal process.
195
196
197
## Values (WIP)
AGENTS.md
+6
@@ -214,6 +214,12 @@ Per [CONTRIBUTING.md](.github/CONTRIBUTING.md), AI-assisted contributions (which
214
3. **Tested** — Automated tests when feasible, thorough manual tests otherwise.
215
4. **Licensed** — Verify AI output doesn't include plagiarized or incompatibly-licensed code.
216
217
+## Releases
218
+
219
+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
220
+release, use the [Release Proposal](https://github.com/caddyserver/caddy/actions/workflows/release-proposal.yml) CI workflow or vote either for or against
221
+an existing matching proposal in the pull requests by reviewing it either for or against.
222
+
223
## Other Guidelines
224
225
- **Avoid new dependencies** — Justify any additions; tiny deps can be inlined