GRM-47: docs: tell users to checkout latest release tag before make setup

2026-06-21 23:39:16 +00:00
parent c8e12dc722
commit b2b7383266
5 changed files with 21 additions and 1 deletions
@@ -5,11 +5,14 @@
 ```bash
 git clone https://git.oblachno.oblachno.fyi/oblachno-oss/grm.git
 cd grm
+git checkout $(git describe --tags --abbrev=0)  # Checkout latest stable release
 pyenv install 3.12
 pyenv local 3.12
 make setup
 ```

+> **Important:** Always checkout the latest release tag before running `make setup`. The `master` branch may contain unreleased changes that are not yet stable. The `git describe --tags --abbrev=0` command automatically selects the most recent tagged release. To see all available releases, run `git tag --sort=-version:refname` or check the [releases page](https://git.oblachno.oblachno.fyi/oblachno-oss/grm/releases).
+
 ## Configure Gitea Credentials

 GRM needs two tokens from your Gitea instance: a **registration token** (required) and an **admin API token** (optional, for post-install verification).
@@ -1,5 +1,7 @@
 # Installation

+> **Before you start:** Make sure you have cloned the repo and checked out the latest stable release tag. See [Getting Started](https://git.oblachno.oblachno.fyi/oblachno-oss/grm/wiki/Getting-Started.-) for setup instructions. Do not run from `master` — it may contain unreleased changes.
+
 ## Prerequisites

 - **SSH key authentication** — The remote host must be reachable via SSH using the user specified with `--user` and the private key specified with `--key`. GRM uses Ansible under the hood, which connects to the target host over SSH to execute all installation and configuration tasks. Without valid SSH credentials, Ansible cannot establish a connection and the deployment will fail.