docs: document CI backend switching in README #150

Closed
opened 2026-03-24 00:30:59 +00:00 by kert · 1 comment
Owner

Add CI/CD section to README: how to switch backends, secret mapping (Woodpecker secrets vs GitHub repo secrets), known limitations per backend. Update gen_config.py --help.

Add CI/CD section to README: how to switch backends, secret mapping (Woodpecker secrets vs GitHub repo secrets), known limitations per backend. Update gen_config.py --help.
kert added this to the P19: CI Backend Abstraction — switchable Woodpecker / GitHub Actions milestone 2026-03-24 00:30:59 +00:00
kert added the docs label 2026-03-24 00:30:59 +00:00
Author
Owner

Resolved in 2054143.

What was done:

  1. README CI/CD section rewritten with:

    • Backend switching table (gitea, github, woodpecker) with workflow directories
    • Step-by-step instructions: edit stack.toml [ci] backend, then gen_config.py
    • Explanation of the generator flow (reads images → dispatches to backend emitter → writes YAML → cleans stale dirs)
    • Secret mapping table: how REGISTRY_TOKEN, GITEA_TOKEN, GITHUB_TOKEN map across backends
    • Updated pipeline table (6 workflows with accurate descriptions)
  2. gen_config.py --help fixed:

    • --backend help text changed from (woodpecker|github) to (gitea|github|woodpecker)
  3. README project layout updated to reflect P24 tree reorg:

    • infra/ directory (images, traefik, grafana, etc.)
    • assets/ directory (css, icons, nature.py)
    • cloud/ directory (self-hosted, aws, gcp, azure)
    • Stale references fixed: styles/ → assets/, .woodpecker/ → .gitea/, scattered Dockerfiles → infra/images/
  4. Coverage badge path fixed: styles/coverage.svg → assets/icons/coverage.svg

  5. Design system section updated: styles/ → assets/css/, assets/nature.py

Resolved in 2054143. **What was done:** 1. **README CI/CD section rewritten** with: - Backend switching table (gitea, github, woodpecker) with workflow directories - Step-by-step instructions: edit `stack.toml [ci] backend`, then `gen_config.py` - Explanation of the generator flow (reads images → dispatches to backend emitter → writes YAML → cleans stale dirs) - Secret mapping table: how `REGISTRY_TOKEN`, `GITEA_TOKEN`, `GITHUB_TOKEN` map across backends - Updated pipeline table (6 workflows with accurate descriptions) 2. **gen_config.py --help** fixed: - `--backend` help text changed from `(woodpecker|github)` to `(gitea|github|woodpecker)` 3. **README project layout** updated to reflect P24 tree reorg: - `infra/` directory (images, traefik, grafana, etc.) - `assets/` directory (css, icons, nature.py) - `cloud/` directory (self-hosted, aws, gcp, azure) - Stale references fixed: `styles/` → `assets/`, `.woodpecker/` → `.gitea/`, scattered Dockerfiles → `infra/images/` 4. **Coverage badge path** fixed: `styles/coverage.svg` → `assets/icons/coverage.svg` 5. **Design system section** updated: `styles/` → `assets/css/`, `assets/nature.py`
kert closed this issue 2026-03-24 20:44:03 +00:00
Sign in to join this conversation.
1 Participants
Notifications
Due Date
No due date set.
Dependencies

No dependencies set.

Reference: homelab/stack#150