Repository navigation
Install guide: use a tested release tag instead of dev #106
Copy link
Copy link
Open
Labels
documentationImprovements or additions to documentationImprovements or additions to documentationplannedActive backlog; exempt from stale botActive backlog; exempt from stale bot
Description
Both install guides tell users to clone dev, which changes on every commit. A user who follows the guide can get a broken build, as happened on 2026-10-20.
This issue changes no code. Do it first. It does not need #107 or #108.
Where users are sent to dev
| Location | Text |
|---|---|
https://sitmun.github.io/getting-started/instalacion/ (source: sitmun/sitmun.github.io docs/getting-started/instalacion.md) |
git clone --branch dev --recurse-submodules … |
Stack README.md, Quick Start and Development Installation |
same command |
On 2026-10-20 an outside user followed sitmun.org → Projecte → sitmun.github.io → Instalación. docker compose up -d built no containers, because #97 had just broken the front image (fixed by #99, prevented by #108).
Facts
mainis the default branch and equals thesitmun-application-stack/1.2.9tag (a2777001, 2026-09-20). Only--branch devputs users on unreleased code.sitmun-application-stack/1.2.9has not been verified to start withdocker compose up -don a clean clone.- This repository has tags but no GitHub Releases (
gh release listis empty). Release notes exist only inCHANGELOG.md. - The guide says
./setup.shcopies.env.example. That file was removed (CHANGELOG.md).setup.shcopiesprofiles/development-postgres.envwhen.envis missing. - 1.3.0, the first LTR (LTR 1.3.0 #104), is about to be released and is the natural tag to name.
Tasks
- On a clean machine, clone the target tag (1.3.0 when cut, or 1.2.9 in the meantime) with
--recurse-submodules, run./setup.shanddocker compose up -d, and confirm admin and viewer load. Record the result on the release. - Publish a GitHub Release for that tag, with notes from its
CHANGELOG.mdsection. - Change the end-user steps in both guides to
git clone --branch sitmun-application-stack/X.Y.Z --recurse-submodules …. - Move
--branch devinto a separate "Development" section that saysdevcan be broken. - Replace
.env.examplein the guide withprofiles/development-postgres.env. - Add making a GitHub Release, and updating the tag in both guides, to
RELEASE.md.
Acceptance
- Following the public guide with no extra knowledge installs a tagged release that has been verified on a clean clone.
- That tag has a GitHub Release with notes.
Reactions are currently unavailable
Metadata
Metadata
Assignees
Labels
documentationImprovements or additions to documentationImprovements or additions to documentationplannedActive backlog; exempt from stale botActive backlog; exempt from stale bot
Activity
[-]Point the install guide at a tagged release instead of dev[/-][+]Install guide: use a tested release tag instead of dev[/+]