Skip to content

docs: link the release runbook from CONTRIBUTING + README #83

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
hellno merged 1 commit into from
Jun 18, 2026
Merged

docs: link the release runbook from CONTRIBUTING + README #83

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
8 changes: 8 additions & 0 deletions CONTRIBUTING.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -231,6 +231,14 @@ Don't deviate from `DESIGN.md` without explicit maintainer approval.
- Satisfy the full **Definition of Done** before requesting review, and include the command output
as evidence.

## Releasing

Cutting a versioned release is a maintainer task with its own runbook:
[`docs/RELEASING.md`](docs/RELEASING.md). In short — bump every crate version, promote the
`CHANGELOG.md` `[Unreleased]` block to the new version, run `just release-check vX.Y.Z` to
pre-flight, then push the tag. The `release.yml` workflow gates on the full CI and publishes a
source-only GitHub Release automatically (no binaries; the unsigned `.app` path stays manual).

## Where to look

| File | What it is |
Expand Down
1 change: 1 addition & 0 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -246,6 +246,7 @@ reviewing self-custody enforcement is your thing, please reach out.
- [`SECURITY.md`](SECURITY.md) — how to report a vulnerability **privately**
(to report privately, use GitHub's **Security** tab → **Report a vulnerability**).
- [`CHANGELOG.md`](CHANGELOG.md) — what changed, release by release.
- [`docs/RELEASING.md`](docs/RELEASING.md) — how to cut a versioned release (maintainers).

Repo: <https://github.com/hellno/deckard>.

Expand Down
Loading