Skip to content

Commit 6f2a938

Browse files
committed
fix: Fixed the bug that the Zig version jumps, and now fmt is not
required
1 parent 0cc1c64 commit 6f2a938

3 files changed

Lines changed: 12 additions & 3 deletions

File tree

.github/PULL_REQUEST_TEMPLATE.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -8,4 +8,4 @@
88
a `REUSE.toml` annotation if a header doesn't fit the file format
99
- [ ] `reuse lint` passes
1010
- [ ] `zig build test -Doptimize=ReleaseSafe` passes
11-
- [ ] `zig fmt --check .` is clean
11+
- [ ] `zig fmt .` applied (CI's formatting check is currently non-blocking, see `CONTRIBUTING.md`)

.github/workflows/ci-zig.yml

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -19,6 +19,11 @@ jobs:
1919
fmt:
2020
name: Formatting
2121
runs-on: ubuntu-latest
22+
# Non-blocking for now: this repo tracks Zig master, and `zig fmt`'s output shifts between
23+
# nightly builds, so a contributor's locally-installed Zig can disagree with whatever CI
24+
# happens to resolve `master` to on a given day. Drop `continue-on-error` once local/CI
25+
# toolchains are pinned to the same version (see CONTRIBUTING.md).
26+
continue-on-error: true
2227
steps:
2328
- uses: actions/checkout@v4
2429

CONTRIBUTING.md

Lines changed: 6 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -63,5 +63,9 @@ license of the directory the file lives in. Run `reuse lint` before submitting;
6363

6464
## Pull requests
6565

66-
Keep PRs scoped to one change. Make sure `zig build test -Doptimize=ReleaseSafe`, `zig fmt --check
67-
.`, and `reuse lint` all pass before opening — see the PR template's checklist.
66+
Keep PRs scoped to one change. Make sure `zig build test -Doptimize=ReleaseSafe` and `reuse lint`
67+
both pass before opening — see the PR template's checklist. Run `zig fmt .` too, but note that CI's
68+
formatting check is currently non-blocking (`continue-on-error`): this repo tracks Zig master, and
69+
`zig fmt`'s output can disagree between your locally-installed Zig and whatever nightly CI resolves
70+
`master` to on a given day. See the `fmt` job in `.github/workflows/ci-zig.yml` for the exact
71+
reasoning and when to turn the gate back on.

0 commit comments

Comments
 (0)