Niklas Ye
dc53d49c3e
CI / test (push) Successful in 2s
go vet says nothing about import order, so when the move to git.ryuvia.com rewrote every import path without re-sorting them -- the new path sorts before github.com/..., where the old one sorted after -- both repos went through a green CI run and a release unformatted. Added to the release workflow as well as CI, so the two keep running the same checks; ci.yaml's header claims exactly that, and a check in one but not the other would quietly make it false. The step handles gofmt's two failure modes separately because they do not look alike: a misformatted file is listed on stdout with exit 0, so the failure has to be raised by hand, while a file that does not parse prints nothing to stdout and exits 2 -- which a plain emptiness test reads as success. Verified against all three cases (clean, misformatted, unparseable) before committing.
90 lines
3.5 KiB
YAML
90 lines
3.5 KiB
YAML
name: CI
|
|
|
|
# The release workflow gates a tag, which is late: a broken commit sits green until
|
|
# somebody decides to publish. This runs the same checks on the way in.
|
|
#
|
|
# push is scoped to main so that a branch pushed as part of a pull request is not checked
|
|
# twice.
|
|
#
|
|
# No actions/checkout, deliberately -- same as the terdut-server, letsvisit and charts
|
|
# workflows. The runner image is ubuntu:22.04 whose `nodejs` package is Node 12, and
|
|
# actions/checkout@v4 is built with ES2022 static initialiser blocks, so it dies with
|
|
# `SyntaxError: Unexpected token '{'` before running. Cloning with git directly avoids JS
|
|
# actions entirely. This repo is public, so the clone needs no credential at all.
|
|
#
|
|
# `${{ }}` values are passed through `env:` and referenced as quoted shell variables: a
|
|
# ref name is attacker-influenced by anyone who can push a branch or open a PR, and
|
|
# expanding one straight into `run:` is a shell-injection vector.
|
|
on:
|
|
push:
|
|
branches: [main]
|
|
pull_request:
|
|
|
|
# A rapid series of pushes only needs the last one checked.
|
|
concurrency:
|
|
group: ci-${{ github.ref }}
|
|
cancel-in-progress: true
|
|
|
|
env:
|
|
REPO_URL: https://git.ryuvia.com/niklas/terdut-tui.git
|
|
|
|
jobs:
|
|
test:
|
|
runs-on: ubuntu-latest
|
|
container:
|
|
image: golang:1.26.6-bookworm
|
|
# act_runner destroys a job's own volumes when it finishes, so without these every
|
|
# run re-downloads the whole module graph. The names must appear in the runner's
|
|
# container.valid_volumes allowlist (charts/act-runner in the k8s repo); unlisted
|
|
# volumes are dropped silently, so a workflow that looks correct can still be
|
|
# running uncached.
|
|
volumes:
|
|
- go-mod-cache:/go/pkg/mod
|
|
- go-build-cache:/root/.cache/go-build
|
|
- gobin-cache:/go/bin
|
|
steps:
|
|
- name: Checkout
|
|
env:
|
|
REF_NAME: ${{ github.ref_name }}
|
|
HEAD_SHA: ${{ github.event.pull_request.head.sha }}
|
|
run: |
|
|
if [ -n "$HEAD_SHA" ]; then
|
|
# A pull_request ref_name is "<n>/merge", which is not a fetchable branch.
|
|
git clone "$REPO_URL" .
|
|
git checkout -q "$HEAD_SHA"
|
|
else
|
|
git clone --depth=1 --branch "$REF_NAME" "$REPO_URL" .
|
|
fi
|
|
|
|
# This exists because `go vet` does not look at import order: the move to
|
|
# git.ryuvia.com rewrote every import path without re-sorting, the new path sorts
|
|
# before github.com/..., and both repos sat unformatted through a green CI run and
|
|
# a release before anyone noticed.
|
|
#
|
|
# Both of gofmt's failure modes need handling, and they are not alike. A file that
|
|
# is merely misformatted is listed on stdout with exit 0 -- so the failure has to
|
|
# be raised by hand. A file that does not parse is the opposite: nothing on stdout
|
|
# and exit 2, which a naive `[ -n "$unformatted" ]` reads as success. The first
|
|
# draft of this step had exactly that hole.
|
|
- name: Format
|
|
run: |
|
|
if ! unformatted=$(gofmt -l .); then
|
|
echo "::error::gofmt could not parse the tree"
|
|
gofmt -l . # re-run unredirected so the parse errors reach the log
|
|
exit 1
|
|
fi
|
|
if [ -n "$unformatted" ]; then
|
|
echo "::error::not gofmt'd:"
|
|
echo "$unformatted"
|
|
gofmt -d .
|
|
exit 1
|
|
fi
|
|
|
|
- name: Vet
|
|
run: go vet ./...
|
|
|
|
# Covers the API client against a stub server, the Update state machine, and View
|
|
# rendering -- all three are pure enough to test without a terminal.
|
|
- name: Test
|
|
run: go test ./...
|