From cbc54119ed60e27a531ec70722578997f0cc1d9d Mon Sep 17 00:00:00 2001 From: Adrian Bonpin Date: Tue, 4 Aug 2026 22:22:51 +0800 Subject: [PATCH] docs: note to keep README download tables + version in sync on releases --- AGENTS.md | 9 +++++++++ README.md | 8 ++++++++ 2 files changed, 17 insertions(+) diff --git a/AGENTS.md b/AGENTS.md index a566066..cf3405a 100644 --- a/AGENTS.md +++ b/AGENTS.md @@ -149,6 +149,15 @@ cargo build # Rust backend only (from src-tauri/) cargo test # Rust tests ``` +### Releases + +Cut a release from the **`prod`** branch (never feature branches) by tagging it — `git tag vN.M.N && git push origin vN.M.N`. GitHub Actions (`release.yml`) builds installers for macOS (Apple Silicon + Intel), Windows, and Linux and opens a **draft** release (review + publish on GitHub). + +**Before tagging**, keep everything in sync: +- Version number across `package.json`, `src-tauri/Cargo.toml`, and `src-tauri/tauri.conf.json` +- `src/lib/version.test.ts` and `src/lib/docs-coverage.test.ts` if they assert the version +- **Both README download tables** — the top **Download** section and the **Which file should I download?** section in Getting Started — they **hardcode** the current version in the asset filenames + direct `releases/download/...` links and must be bumped to the new version + ### Adding a Tauri Command 1. Define the command function in the appropriate `src-tauri/src/commands/` module diff --git a/README.md b/README.md index 050a857..997b8db 100644 --- a/README.md +++ b/README.md @@ -44,6 +44,14 @@ Grab the installer for your OS from the latest release (v0.7.0): > Not sure if your Mac is Intel or Apple Silicon? See [Which file should I download?](#which-file-should-i-download) below. All installers are **unsigned** — see the [notes](#which-file-should-i-download) on first-launch warnings. + + --- ## What is Gridline?