From e058741032316033cf2f7b43b845975ae0c95839 Mon Sep 17 00:00:00 2001 From: ShortArrow Date: Tue, 20 Oct 2026 15:46:44 +0900 Subject: [PATCH] docs: hold the APT install steps until the registry serves packages The README promised an apt install that fails at apt update until ShortArrow/pkg starts publishing; the steps return when it does. --- CHANGELOG.md | 5 ++--- README.md | 21 +-------------------- docs/CONTRIBUTING.md | 6 +++--- 3 files changed, 6 insertions(+), 26 deletions(-) diff --git a/CHANGELOG.md b/CHANGELOG.md index b9235da..c463a57 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -21,9 +21,8 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0 when the origin is on github.com or gitlab.com, copies or opens the commit's web page ([#15](https://github.com/ShortArrow/gitreant/issues/15)). -- Debian packages for amd64 and arm64 are attached to each release, for the - APT repository at `pkg.shortarrow.jp` once it starts publishing, and a - `SHA256SUMS` lists every release asset +- Each release carries Debian packages for amd64 and arm64, and a + `SHA256SUMS` listing every release asset ([ADR 0034](https://github.com/ShortArrow/gitreant/blob/main/docs/adr/0034-debian-packages.md)). ### Changed diff --git a/README.md b/README.md index 66cd6af..e0a2281 100644 --- a/README.md +++ b/README.md @@ -58,26 +58,7 @@ Every feature in detail: [docs/FEATURES.md](docs/FEATURES.md). ## Install / Build -On Debian 12 or Ubuntu 22.04 and later, amd64 or arm64, from the APT -repository at `pkg.shortarrow.jp` -([ADR 0034](docs/adr/0034-debian-packages.md)): - -```console -$ sudo curl -fsSLo /usr/share/keyrings/shortarrow-archive-keyring.gpg https://pkg.shortarrow.jp/apt/shortarrow-archive-keyring.gpg -$ echo "deb [signed-by=/usr/share/keyrings/shortarrow-archive-keyring.gpg] https://pkg.shortarrow.jp/apt stable main" | sudo tee /etc/apt/sources.list.d/shortarrow.list -$ sudo apt update -$ sudo apt install shortarrow-archive-keyring gitreant -``` - -Installing `shortarrow-archive-keyring` by name keeps it, and the key that -verifies the repository, when gitreant is removed; later keys arrive with -`apt upgrade`. `gitreant --version` checks the install. - -The repository does not serve packages yet. Until it does, these steps -fail at `apt update`, and the `.deb` files on the GitHub Release do not -install on their own, since they depend on `shortarrow-archive-keyring`. - -Every GitHub Release also carries the binaries for Windows, macOS, Linux +Every GitHub Release carries the binaries for Windows, macOS, Linux and Termux, with a `SHA256SUMS`. To build from source, you need Rust (stable), Node.js + pnpm: diff --git a/docs/CONTRIBUTING.md b/docs/CONTRIBUTING.md index e8f7dbd..9672ad4 100644 --- a/docs/CONTRIBUTING.md +++ b/docs/CONTRIBUTING.md @@ -168,9 +168,9 @@ How a release is guarded is [ADR 0030](adr/0030-release-safeguards.md). Debian packages from the Linux ones and installs them with apt in containers ([ADR 0034](adr/0034-debian-packages.md)), attests them all (SLSA provenance) and attaches them, with a `SHA256SUMS`, to a - GitHub Release whose notes are the changelog section. The APT - registry ([ShortArrow/pkg](https://github.com/ShortArrow/pkg)) picks - the packages up from there within the hour; + GitHub Release whose notes are the changelog section. Once the APT + registry ([ShortArrow/pkg](https://github.com/ShortArrow/pkg)) + publishes, it picks the packages up from there within the hour; 4. waits for approval in the `release` environment, then publishes the crate to crates.io via OIDC Trusted Publishing. The published package ships the prebuilt `frontend/dist` (see the `include` list in