diff --git a/CLI-AUTOMATION-NOTES.md b/CLI-AUTOMATION-NOTES.md index 937fed0..36aa315 100644 --- a/CLI-AUTOMATION-NOTES.md +++ b/CLI-AUTOMATION-NOTES.md @@ -7,7 +7,7 @@ useful a fix in **wallet-cli / wallet-core** (or clearer APIs) would be. Companions: - Android GUI → [`android-test/GUI-AUTOMATION-NOTES.md`](./android-test/GUI-AUTOMATION-NOTES.md) -- Git / suite tree → [`VERSIONS.md`](./VERSIONS.md) +- Git / suite tree → [`GIT-AUTOMATION-NOTES.md`](./GIT-AUTOMATION-NOTES.md) Scripts: `check_e2e.sh`, `check_goa_ladder.sh`, `taler-monitoring.sh`. diff --git a/GIT-AUTOMATION-NOTES.md b/GIT-AUTOMATION-NOTES.md new file mode 100644 index 0000000..92da5d0 --- /dev/null +++ b/GIT-AUTOMATION-NOTES.md @@ -0,0 +1,103 @@ +# Git / release notes — **taler-monitoring** + +How we commit, tag, and push this **standalone** suite +(`https://git.hacktivism.ch/hernani/taler-monitoring`). + +This file is **only** git/release/cadence for the suite tree. +**Do not confuse with:** + +| File | Topic | +|------|--------| +| [`android-test/GUI-AUTOMATION-NOTES.md`](./android-test/GUI-AUTOMATION-NOTES.md) | Android **GUI** automation | +| [`CLI-AUTOMATION-NOTES.md`](./CLI-AUTOMATION-NOTES.md) | wallet-cli e2e pain points | + +Three different `*AUTOMATION-NOTES.md` files on purpose (GIT / GUI / CLI). + +--- + +## Canonical tree + +| | | +|--|--| +| Clone | `~/src/taler-monitoring` | +| Remote | `https://git.hacktivism.ch/hernani/taler-monitoring.git` | +| Branch | `main` | +| Tags | `vMAJOR.FEATURE.FIX` (see [`VERSIONS.md`](./VERSIONS.md)) | +| Symlink (optional) | `~/taler-monitoring` → suite dir (`update-suite.sh`) | + +There is **no** `scripts/` subtree under an ops admin-log for this suite. +Host ops (Caddy, landings, day logs) stay in **koopa-admin-log** (separate repo). + +--- + +## Commit / push cadence + +| Rule | Practice | +|------|----------| +| **Commits** | Prefer frequent small commits (`area: short description`) | +| **Areas** | e.g. `host-agent: …`, `site-gen: …`, `monpages: …`, `docs: …`, `release: …` | +| **Push** | At end of a work slice / session — not after every micro-commit | +| **Tags** | After a fix/feature lands on `main`, tag + push tag (e.g. `v1.4.1`) | + +```bash +cd ~/src/taler-monitoring +git status -sb +git add -A && git commit -m "area: description" +# session end: +git push origin main +git tag -a v1.3.3 -m "v1.3.3: …" +git push origin v1.3.3 +``` + +### Push from koopa (HTTPS + Forgejo token) + +Laptop SSH keys often cannot push to Forgejo; on **koopa** a token file is used +(ops-only, never commit it): + +```bash +# example — do not print the token +TOK=$(tr -d '\n\r ' < ~/.config/forgejo-taler-monitoring.token) +git push "https://hernani:${TOK}@git.hacktivism.ch/hernani/taler-monitoring.git" main +``` + +Prefer `git push origin …` once `credential.helper` / remote URL is set up. + +### Host-agent auto-update + +`host-agent/update-suite.sh` does `git fetch` + `reset --hard` to `SUITE_GIT_REF` +(default `main`). Local uncommitted suite edits under `~/src/taler-monitoring` +can be wiped — keep work in a branch or commit first. Stack env lives only in +`~/.config/taler-monitoring/env` (never overwritten by git). + +--- + +## What the suite runs (no Android) + +| Phase | Needs | +|-------|--------| +| `urls` / `sanity` | public HTTPS | +| `inside` / `versions` | SSH / podman on local stacks | +| `monpages` | public FQDN of **monitoring HTML** (not merchant JSON code 21) | +| `e2e` / `ladder` | `taler-wallet-cli` + secrets | +| `surface` / `aptdeploy` | explicit only (timers on koopa) | + +```bash +./taler-monitoring.sh -d hacktivism.ch urls monpages +./taler-monitoring.sh -d stage.lefrancpaysan.ch e2e # after secrets.env +``` + +Mobile / GUI → **GUI-AUTOMATION-NOTES** and `android-test/`. + +--- + +## Related docs + +| Doc | Role | +|-----|------| +| [README.md](./README.md) | how to run `taler-monitoring.sh` | +| [VERSIONS.md](./VERSIONS.md) | release tags | +| [TESTS.md](./TESTS.md) | grouped check IDs | +| [secrets.env.example](./secrets.env.example) | e2e secrets layout | +| [host-agent/README.md](./host-agent/README.md) | systemd timers / install | +| [android-test/GUI-AUTOMATION-NOTES.md](./android-test/GUI-AUTOMATION-NOTES.md) | Android GUI automation | +| [CLI-AUTOMATION-NOTES.md](./CLI-AUTOMATION-NOTES.md) | wallet-cli automation issues | diff --git a/README.md b/README.md index 18e9d9a..e9a0bcc 100644 --- a/README.md +++ b/README.md @@ -57,7 +57,7 @@ Report for the **GOA** stack with boxed severity badges and **grouped test IDs** IDs reset per **group** inside an area — so “too many www tests” become `www.exchange-*`, `www.bank-*`, `www.landing-*`, etc. Catalog: **[TESTS.md](./TESTS.md)**. -Git / tags / suite tree: **[VERSIONS.md](./VERSIONS.md)**. +Git / tags / suite tree: **[GIT-AUTOMATION-NOTES.md](./GIT-AUTOMATION-NOTES.md)**. GUI Android notes: **[android-test/GUI-AUTOMATION-NOTES.md](./android-test/GUI-AUTOMATION-NOTES.md)**. CLI / wallet-cli recurring issues: **[CLI-AUTOMATION-NOTES.md](./CLI-AUTOMATION-NOTES.md)**. diff --git a/android-test/GUI-AUTOMATION-NOTES.md b/android-test/GUI-AUTOMATION-NOTES.md index 333179f..f35eda9 100644 --- a/android-test/GUI-AUTOMATION-NOTES.md +++ b/android-test/GUI-AUTOMATION-NOTES.md @@ -3,7 +3,7 @@ Companion docs: - CLI / wallet-cli: [`../CLI-AUTOMATION-NOTES.md`](../CLI-AUTOMATION-NOTES.md) -- Git / tags / suite tree: [`../VERSIONS.md`](../VERSIONS.md) +- Git / tags / suite tree: [`../GIT-AUTOMATION-NOTES.md`](../GIT-AUTOMATION-NOTES.md) Canonical notes for **graphical** Android wallet tests against GOA / stage. diff --git a/android-test/README.md b/android-test/README.md index 977ff0c..64e9d8a 100644 --- a/android-test/README.md +++ b/android-test/README.md @@ -108,4 +108,4 @@ Canonical notes (minimal variant, **flags**, Linux defaults): WINDOWED=1 ./start-android-emulator.sh --wait ``` -See also parent [VERSIONS.md](../VERSIONS.md). +See also parent [GIT-AUTOMATION-NOTES.md](../GIT-AUTOMATION-NOTES.md).