vinzenz/hyperhive
vinzenz/hyperhive
Watch
0
0
Fork
You've already forked hyperhive
 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions 1

docs(ci): update CI workflow section to reflect 3-job layout

Browse source
This commit is contained in:
atlas 2026-07-04 20:41:39 +02:00 • committed by mara
commit bfba148f76
1 changed files with 37 additions and 4 deletions
Download patch file Download diff file Expand all files Collapse all files

41
docs/ci.md
View file

@ -110,24 +110,57 @@ to avoid provisioning collisions.
## CI workflow ## CI workflow
The single CI job is defined in `.forgejo/workflows/ci.yml`: Three jobs are defined in `.forgejo/workflows/ci.yml`:
```yaml ```yaml
name: CI name: CI
on: on:
pull_request: pull_request:
branches: ["**"] branches: ["**"]
# workflow_dispatch lets `hive-forge ci-rerun --pr N` retrigger without
# an empty commit.
workflow_dispatch:
jobs: jobs:
check: check:
name: nix flake check name: nix flake check
runs-on: [hive-ci] runs-on: [hive-ci]
timeout-minutes: 30
steps: steps:
- uses: actions/checkout@v3 - uses: actions/checkout@v3
- name: check - run: nix flake check
run: nix flake check
tracker-tags:
name: tracker-tag lint
runs-on: [hive-ci]
timeout-minutes: 5
steps:
- uses: actions/checkout@v3
- run: sh scripts/check-issue-refs.sh
comment-blocks:
name: comment-block lint
runs-on: [hive-ci]
timeout-minutes: 5
steps:
- uses: actions/checkout@v3
- run: sh scripts/check-comment-blocks.sh
``` ```
This runs on every PR, executing all flake checks (treefmt, rustfmt, cargo test, cargo clippy, module evaluation). No `--no-build`: the checks' derivations are the canonical source of truth. - **`nix flake check`** — all flake checks: formatting (treefmt+rustfmt),
cargo test, cargo clippy, module evaluation, `hivectl-docs` freshness.
No `--no-build`: the check derivations are the canonical source of truth.
30-minute wall-clock cap.
- **`tracker-tag lint`** — flags `#NNN` tracker references in non-markdown
source (hive convention: use prose in code, not tags). Non-blocking for
now (doesn't gate merge) while the legacy backlog is cleaned up.
- **`comment-block lint`** — flags contiguous comment blocks over 30 lines.
Prose belongs in `docs/`, not inline. Also non-blocking while the tree
settles.
All three jobs run in parallel on each PR push. `hive-forge ci-rerun --pr N`
dispatches a fresh `workflow_dispatch` run without an empty commit — the
correct way to retry a transient CI failure.
## Security: unsandboxed builds and trusted contributors ## Security: unsandboxed builds and trusted contributors