mirror of https://seed.radicle.dev/rad:z4V1sjrXqjvFdnCUbxPFqd5p4DtH5.git synced 2026-11-13 18:40:50 +08:00

Files

T

Daniel Norman e1f7a40c63 httpd: Set up the tag release flow

- Rename RADICLE_VERSION to RADICLE_HTTPD_VERSION, apart from
  heartwood's RADICLE_VERSION
- Add Unreleased sections to the changelog and API changes log, so
  patches add their highlights as they land
- Replace the release patch with a signed tag that one delegate
  pushes
- Stop pushing the tag from upload: the delegate who makes the tag
  pushes it
- Remove build/changelog
- Add build/prepare to rename the Unreleased sections, in POSIX sh
  and awk
- Ask a major release to set the target date to drop the previous
  major
- Fix the signing key setup: use the bare key that build/tag
  compares against

2026-10-29 18:32:03 +01:00

5.2 KiB

Raw Blame History

Release Process

radicle-httpd and radicle-search are released together from this workspace: a single tag, a single changelog, and one build run that produces artifacts for both binaries. They share the same version number, set by the release tag. On files.radicle.dev each binary gets its own release folder — releases/radicle-httpd/<version>/ and, as a sibling, releases/radicle-search/<version>/ — so existing radicle-httpd download URLs are unaffected and radicle-search is downloaded independently.

The release tooling lives in crates/radicle-httpd/build/.

Scope

Releases cover only the radicle-httpd and radicle-search binaries. The web front-end (radicle-explorer) is not released this way: it is deployed continuously (rolling release) and must always remain compatible with the latest radicle-httpd/radicle-search release.

Versioning

Versions follow semantic versioning. The version covers the HTTP API, the CLI and the config: bump the minor version for additions, and the major version for removals or changes. Before 1.0, 0.y counts as the major, so bump 0.y.z to 0.y.(z+1) for additions and to 0.(y+1).0 for removals or changes. The release tag sets the version; do not change it in Cargo.toml. See ADR 0001 for which releases explorer supports.

Prerequisites

Git signing configured via SSH:

git config set gpg.format ssh
git config set user.signingKey "$(rad self --ssh-key)"

Working podman setup (see Podman Setup below)
Required tools: podman, rad, sha256sum

Prepare

Normal patches add their highlights to ## Unreleased in CHANGELOG.md. Note in each entry whether the change belongs to radicle-httpd or radicle-search.

Release

Update master:

git switch master
git pull --ff-only rad master

Make the release commit. The script renames ## Unreleased to the version in CHANGELOG.md and docs/api-changes.md, and adds a new empty ## Unreleased to each:
```
crates/radicle-httpd/build/prepare <version>
```
Check the diff. Then add the API changes from docs/api-changes.md to the new section in CHANGELOG.md. If the release bumps the major, set the target date to drop the previous major in ## Support of docs/api-changes.md, three months from today. Then commit:
```
git commit -am "httpd: Release <version>"
```
Make and sign the tag. The script checks the signing key:
```
crates/radicle-httpd/build/tag <version>
```
Push the commit and the tag. Push only this tag, not --tags. The push reports that the canonical reference is updated:
```
git push rad master refs/tags/releases/httpd/<version>
rad sync --announce
```

Build and upload

Do these steps after the tag is canonical.

Check out the tag. The build reads the version from it with git describe:
```
git switch --detach releases/httpd/<version>
```
Run the reproducible build (Linux x86_64 or macOS). A single run compiles the workspace and packages both binaries, one archive per binary per target:
```
crates/radicle-httpd/build/build
```
This writes to crates/radicle-httpd/build/artifacts/:
- radicle-httpd-<version>-<target>.tar.xz (binary + man page)
- radicle-search-<version>-<target>.tar.xz (binary)
each with a .sig and .sha256 alongside.
Upload. This publishes each binary into its own sibling folder on files.radicle.dev and creates the version-less and latest symlinks for both:
```
SSH_LOGIN=<username> crates/radicle-httpd/build/upload
```
Warning: Uploading immediately publishes the release.

Announce

Mark the previous release as resolved in Zulip #Announcements

Create a new announcement with the following template:

Topic: radicle-httpd + radicle-search <version>

Message:

# 👾 radicle-httpd + radicle-search <version>

`radicle-httpd` and `radicle-search` <version> (<build-id>) are released.

## Installation

Download binaries from:

- https://files.radicle.dev/releases/radicle-httpd/<version>
- https://files.radicle.dev/releases/radicle-search/<version>
- https://radicle.dev/download

## Changelog

<copy the <version> section from CHANGELOG.md>

## Checksums

```
<copy output from crates/radicle-httpd/build/checksums>
```

:info: This release was built on <platform>. Build reproducibility across
platforms is unsupported; checksums may differ if rebuilt elsewhere.

Notes

Important:

macOS binaries are unsigned and not notarized; download via CLI only

Build reproducibility across platforms is not guaranteed

Podman Setup

We use podman for reproducible builds across machines. It's preferred over Docker because it runs without a daemon and doesn't require root access.

On first run, you may need to configure UID/GID ranges:

sudo usermod --add-subuids 100000-165535 --add-subgids 100000-165535 $USER
podman system migrate

5.2 KiB Raw Blame History