Skip to content

Add a godebug input so a caller can set GODEBUG for go test #1

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
Fly-Playgroud merged 1 commit into from
Sep 6, 2026
Merged

Add a godebug input so a caller can set GODEBUG for go test #1

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
9 changes: 9 additions & 0 deletions .github/workflows/go.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -30,6 +30,13 @@ on:
description: Directory of the Go module, relative to the repository root.
type: string
default: .
godebug:
description: >-
GODEBUG for the test binaries, e.g. tracebackancestors=1000 for a
suite built on leakcheck. Empty leaves it unset. A called workflow
does not inherit the caller's env, hence an input.
type: string
default: ""

permissions:
contents: read
Expand Down Expand Up @@ -81,6 +88,8 @@ jobs:
- run: go vet ./...

- run: go test -race -count=1 -covermode=atomic -coverprofile=coverage.out ./...
env:
GODEBUG: ${{ inputs.godebug }}

- name: Coverage ratchet
if: matrix.os == 'ubuntu-latest' && matrix.go == 'stable'
Expand Down
2 changes: 2 additions & 0 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -30,6 +30,7 @@ Organisation-wide defaults for [headlesslab](https://github.com/headlesslab) rep
| `coverage-threshold` | number | required | Minimum total statement coverage in percent, measured on the `ubuntu-latest` / `stable` job. Set it to the module's current coverage (for a snapshot-imported Satellite, the level it was imported at) and only ever raise it. |
| `cross-platform` | boolean | `false` | Also run the `test` job on `windows-latest` and `macos-latest`, on Go `stable`. |
| `working-directory` | string | `.` | Directory of the Go module, relative to the repository root. |
| `godebug` | string | empty | `GODEBUG` for the test binaries on every `test` cell, e.g. `tracebackancestors=1000` for a suite built on [leakcheck](https://github.com/headlesslab/leakcheck). A called workflow does not inherit the caller's `env`, so the variable travels as an input. |

### Calling it

Expand All @@ -56,6 +57,7 @@ jobs:
with:
coverage-threshold: 90
# cross-platform: true # only where OS behaviour matters (file locks, renames)
# godebug: tracebackancestors=1000 # only for a suite built on leakcheck
```

The resulting check names are `go / test (ubuntu-latest, floor)`, `go / test (ubuntu-latest, stable)`, `go / lint` and `go / govulncheck`, plus `go / test (windows-latest, stable)` and `go / test (macos-latest, stable)` with `cross-platform: true`. Those are the Gates a Satellite's `main` ruleset requires.
Expand Down