Cursor rule

1---
2description: "CI pipeline setup with bundled, forge-neutral templates and local validation. Detects the forge from the git remote, generates workflows for supported forges, and skips honestly for the rest. The CI equivalent of wire-observability."
3alwaysApply: false
4---
5 
6# Wire CI
7 
8> **HARD GATE (supported forges only)** — Do not ship a project without CI. Run this skill before first merge to main.
9>
10> On a forge bigpowers ships no templates for, this skill **is not a gate**: it reports the forge, explains what it cannot do, and exits 3. A gate that cannot run must not claim it did. See § Unsupported forges.
11>
12> **HARD GATE** — CI that is untestable locally will break every cycle. Always run `--validate` after generating workflows and `--dry-run` before pushing.
13 
14Generate, validate, and test CI workflows. Detects the forge and project type, copies a **bundled** template, and verifies locally before anything reaches CI.
15 
16## Forge resolution
17 
18`scripts/lib/detect-forge.sh` resolves the forge, first match wins: `BIGPOWERS_FORGE` env var → `forge:` in `specs/forge.yaml` → the `origin` remote URL → `unknown`.
19 
20```bash
21bash scripts/wire-ci.sh --detect     # report forge + stack, write nothing
22bash scripts/wire-ci.sh --plan       # show the template that would be used
23bash scripts/wire-ci.sh --apply      # write the workflow
24```
25 
26GitHub ships templates (`.github/workflows/`). GitLab, Bitbucket, Codeberg, and Gitea are detected but **unsupported** — `--apply` writes nothing and exits 3.
27 
28## Template source — configurable, bundled by default
29 
30Templates live in `docs/templates/ci/<forge>/` **inside the bigpowers package**, so there is no network dependency on any third party's repository. Override with `BIGPOWERS_CI_TEMPLATES=/path/to/your/templates`, laid out as `<root>/<forge>/test-build-release-<stack>.yml`.
31 
32## What this sets up
33 
341. **Test Build Release workflow** — lint → test → build → release in one `needs:` chain
352. **`--validate` mode** — YAML syntax, workflow permissions, required secrets, common pitfalls
363. **`--dry-run` mode** — runs workflows locally via `act` before push
374. **Failure pattern documentation** — see the table below
38 
39Deploy workflows are **not** bundled: they are platform-specific. See [REFERENCE.md](REFERENCE.md) for a worked example.
40 
41## Process
42 
43### 1. Detect forge and stack
44 
45```bash
46bash scripts/wire-ci.sh --detect
47```
48 
49Stack detection reads the project root:
50 
51| Manifest | Stack | Bundled template |
52|----------|-------|------------------|
53| `Cargo.toml` | Rust | `test-build-release-rust.yml` |
54| `package.json` | Node | `test-build-release-node.yml` |
55| `pyproject.toml` / `setup.py` | Python | `test-build-release-python.yml` |
56| `go.mod` | Go | `test-build-release-go.yml` |
57 
58No recognized manifest → exit 3 with the list of manifests it looked for. Do not guess.
59 
60### 2. Apply the template
61 
62```bash
63bash scripts/wire-ci.sh --apply
64```
65 
66**Do not rename the workflow `name:` field** — deploy listens for `"Test Build Release"`.
67 
68Edit placeholders after copying: language versions, `APP_TYPE`, `SITE_URL`.
69 
70### 3. Unsupported forges
71 
72`--apply` writes nothing and exits 3. Your options, in the order the runner prints them:
73 
74- point `BIGPOWERS_CI_TEMPLATES` at templates for your forge
75- pin `forge: github` in `specs/forge.yaml` if the remote is misdetected
76- write the CI config by hand
77 
78Contributing a `docs/templates/ci/gitlab/` set and adding `gitlab` to `FORGE_SUPPORTED_LIST` is the natural next slice — per-forge command mapping (`gh pr checks` → `glab ci status`) is not implemented yet.
79 
80### 4. Validate workflows (`--validate`)
81 
82See [REFERENCE.md](REFERENCE.md). Exit codes: `0` clean, `1` YAML syntax errors, `2` warnings only.
83 
84### 5. Dry-run workflows (`--dry-run`)
85 
86See [REFERENCE.md](REFERENCE.md).
87 
88> **act** runs workflows in a local Docker environment — the most accurate pre-push validation.
89> **gh workflow run** sends the workflow to GitHub but does not execute locally.
90 
91### 6. Document common CI failure patterns
92 
93| Failure | Cause | Fix |
94|---------|-------|-----|
95| `npm publish` fails | `NPM_TOKEN` not set as repo secret | Add `NPM_TOKEN` to repo secrets |
96| `semantic-release` fails on push | Missing `permissions: contents: write` | Add it to the release job |
97| `cargo publish` auth fail | `CARGO_REGISTRY_TOKEN` not set | Add token to env or `~/.cargo/config.toml` |
98| `go vet` fails | Go version mismatch | Use `go-version-file: go.mod` |
99| `cargo clippy` errors | New nightly lints | Pin the toolchain; `cargo clippy --fix` |
100| `act` not found | Docker not running or act missing | `brew install act`; `docker ps` |
101| Hardcoded Node version stale | `.nvmrc` exists but workflow hardcodes | Use `node-version-file: .nvmrc` |
102| Deploy never runs | TBR workflow renamed | Keep `name: Test Build Release` |
103| Release rebuilds binary | Artifact not downloaded | `release` must `download-artifact` from `build` |
104 
105## Verify
106 
107→ verify: `bash scripts/wire-ci.sh --self-test`
108→ verify: `test -f docs/templates/ci/github/test-build-release-node.yml && test -f scripts/lib/detect-forge.sh`
109→ verify: `grep -q wire-ci SKILL-INDEX.md`
110 
111---
112 
113# Wire Ci — Reference
114 
115## Navigation
116 
117| Lines | Section |
118|-------|---------|
119| 1 | Title |
120| 3–20 | Navigation |
121| 21–22 | Examples |
122| 23–39 | Create CI for a Go project (TBR + optional deploy) |
123| 40–49 | Create CI for a CLI tool (TBR only, no deploy) |
124| 50–57 | Validate existing workflows (no generation) |
125| 58–70 | Options |
126| 71–79 | Integration with build-epic |
127| 80–154 | Reference block 1 — test-build-release.yml (Go, excerpt) |
128| 155–204 | Reference block 2 — deploy.yml (generic web app, excerpt) |
129| 205–232 | Reference block 3 — CLI dogfood (big-release pattern) |
130| 233–257 | Reference block 4 — validate script |
131| 258–268 | Reference block 5 — dry-run |
132 
133## Examples
134 
135### Create CI for a Go project (TBR + optional deploy)
136 
137```bash
138# Resolve forge + stack, then apply the bundled template
139bash scripts/wire-ci.sh --detect
140bash scripts/wire-ci.sh --apply
141
142wire-ci --validate
143wire-ci --dry-run
144```
145 
146To use your own org templates instead of the bundled ones:
147 
148```bash
149BIGPOWERS_CI_TEMPLATES=/path/to/your/templates bash scripts/wire-ci.sh --apply
150```
151 
152### Create CI for a CLI tool (TBR only, no deploy)
153 
154```bash
155bash scripts/wire-ci.sh --apply
156# Edit release job to download build artifact — see big-release dogfood
157# CLI/library repos: delete deploy.yml; the release job is terminal.
158
159wire-ci --validate
160```
161 
162### Validate existing workflows (no generation)
163 
164```bash
165wire-ci --validate --check-only
166```
167 
168---
169 
170## Options
171 
172| Flag | Description |
173|------|-------------|
174| `--validate` | Check YAML syntax, permissions, secrets, common pitfalls |
175| `--dry-run` | Run workflows locally via `act` or dispatch via `gh` |
176| `--check-only` | Only validate, do not generate new files |
177| `--type <type>` | Force project type (skip auto-detection) |
178| `--force` | Overwrite existing workflow files |
179| `--no-deploy` | Skip deploy.yml even for hosted stacks |
180 
181---
182 
183## Integration with build-epic
184 
185When `wire-ci` is used as part of `build-epic`:
186 
1871. **During develop-tdd**: If the task modifies `.github/workflows/`, run `wire-ci --validate` as a CI dry-run sub-step
1882. **During release-branch**: After push, run `gh run list --limit 1 --branch main --json status,conclusion` to verify CI passes
189 
190---
191 
192## Reference block 1 — test-build-release.yml (Go, excerpt)
193 
194```yaml
195name: Test Build Release
196on:
197  push:
198    branches: [main]
199  pull_request:
200    branches: [main]
201
202permissions:
203  contents: read
204
205concurrency:
206  group: pipeline-${{ github.workflow }}-${{ github.ref }}
207  cancel-in-progress: true
208
209jobs:
210  lint:
211    runs-on: ubuntu-22.04
212    timeout-minutes: 10
213    steps:
214      - uses: actions/checkout@9c091bb21b7c1c1d1991bb908d89e4e9dddfe3e0  # v7.0.0
215      - uses: actions/setup-go@924ae3a1cded613372ab5595356fb5720e22ba16  # v6.5.0
216        with:
217          go-version: '1.22'
218          cache: true
219      - uses: golangci/golangci-lint-action@55c2c1448f86e01eaae002a5a3a9624417608d84  # v6.5.2
220        with:
221          version: v1.64.8
222
223  test:
224    needs: [lint]
225    runs-on: ubuntu-22.04
226    steps:
227      - uses: actions/checkout@9c091bb21b7c1c1d1991bb908d89e4e9dddfe3e0  # v7.0.0
228      - uses: actions/setup-go@924ae3a1cded613372ab5595356fb5720e22ba16  # v6.5.0
229        with:
230          go-version: '1.22'
231          cache: true
232      - run: go vet ./...
233      - run: go test ./... -count=1
234
235  build:
236    needs: [test]
237    runs-on: ubuntu-22.04
238    steps:
239      - uses: actions/checkout@9c091bb21b7c1c1d1991bb908d89e4e9dddfe3e0  # v7.0.0
240      - uses: actions/setup-go@924ae3a1cded613372ab5595356fb5720e22ba16  # v6.5.0
241        with:
242          go-version: '1.22'
243          cache: true
244      - run: go build ./...
245      - run: jq -n --arg sha "${{ github.sha }}" '{sha: $sha}' > deploy-meta.json
246      - uses: actions/upload-artifact@043fb46d1a93c77aae656e7c1c64a875d1fc6a0a  # v7.0.1
247        with:
248          name: deploy-meta
249          path: deploy-meta.json
250
251  release:
252    if: github.ref == 'refs/heads/main' && github.event_name == 'push'
253    needs: [build]
254    permissions:
255      contents: write
256    steps:
257      - uses: actions/checkout@9c091bb21b7c1c1d1991bb908d89e4e9dddfe3e0  # v7.0.0
258        with:
259          fetch-depth: 0
260      - run: npx semantic-release
261        env:
262          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
263```
264 
265---
266 
267## Reference block 2 — deploy.yml (generic web app, excerpt)
268 
269```yaml
270name: Deploy
271on:
272  workflow_run:
273    workflows: ["Test Build Release"]
274    types: [completed]
275
276permissions:
277  contents: read
278  actions: read
279
280concurrency:
281  group: deploy-production
282  cancel-in-progress: false
283
284env:
285  SITE_URL: "https://CHANGE-ME.example.com"
286
287jobs:
288  deploy:
289    if: >
290      github.event.workflow_run.conclusion == 'success' &&
291      github.event.workflow_run.head_branch == 'main'
292    runs-on: ubuntu-22.04
293    environment: production
294    steps:
295      - uses: actions/download-artifact@3e5f45b2cfb9172054b4087a40e8e0b5a5461e7c  # v8.0.1
296        with:
297          name: deploy-meta
298          github-token: ${{ secrets.GITHUB_TOKEN }}
299          run-id: ${{ github.event.workflow_run.id }}
300          path: deploy-meta
301      # Placeholder deploy step — bigpowers ships no deploy templates and pins
302      # no third-party action. Substitute your platform's own step here, or drop
303      # the deploy job entirely for CLI and library repos. Pin whatever action
304      # you choose to a full commit SHA rather than a tag. (GH #104)
305      - name: Deploy
306        run: |
307          echo "Replace this step with your platform's deploy command."
308          echo "commit=$(jq -r .sha deploy-meta/deploy-meta.json)"
309          exit 1
310      - name: Health check
311        run: |
312          curl -sf "${{ env.SITE_URL }}" || exit 1
313```
314 
315---
316 
317## Reference block 3 — CLI dogfood (big-release pattern)
318 
319```yaml
320  build:
321    needs: [test]
322    steps:
323      - run: make build
324      - uses: actions/upload-artifact@043fb46d1a93c77aae656e7c1c64a875d1fc6a0a  # v7.0.1
325        with:
326          name: big-release-${{ github.sha }}
327          path: bin/big-release
328
329  release:
330    needs: [build]
331    if: github.ref == 'refs/heads/main' && github.event_name == 'push'
332    steps:
333      - uses: actions/download-artifact@3e5f45b2cfb9172054b4087a40e8e0b5a5461e7c  # v8.0.1
334        with:
335          name: big-release-${{ github.sha }}
336          path: bin
337      - run: make release   # cross-compile assets only; host binary from artifact
338      - run: big-release release --verbose
339```
340 
341No `deploy.yml` — CLI publishes via the release job.
342 
343---
344 
345## Reference block 4 — validate script
346 
347```bash
348for f in .github/workflows/*.yml .github/workflows/*.yaml; do
349  [ -f &quot;$f&quot; ] || continue
350  python3 -c &quot;import yaml; yaml.safe_load(open('$f'))&quot; || echo &quot;FAIL: $f has YAML syntax errors&quot;
351done
352
353for f in .github/workflows/test-build-release.yml; do
354  if grep -q &quot;permissions:&quot; &quot;$f&quot;; then
355    echo &quot;OK: $f has permissions block&quot;
356  else
357    echo &quot;WARNING: $f missing permissions block&quot;
358  fi
359done
360
361if grep -q 'workflows: \["Test Build Release"\]' .github/workflows/deploy.yml 2&gt;/dev/null; then
362  if ! grep -q 'name: Test Build Release' .github/workflows/test-build-release.yml; then
363    echo &quot;WARNING: deploy.yml listens for Test Build Release but TBR name may differ&quot;
364  fi
365fi
366```
367 
368---
369 
370## Reference block 5 — dry-run
371 
372```bash
373if command -v act &amp;&gt;/dev/null; then
374  act push --dry-run -W .github/workflows/test-build-release.yml
375elif command -v gh &amp;&gt;/dev/null; then
376  gh workflow run test-build-release.yml --ref &quot;$(git branch --show-current)&quot;
377else
378  echo &quot;Install act or gh for dry-run&quot;
379fi
380```
381