Skip to content

chore: updates the CLI description in docs and help text #325

chore: updates the CLI description in docs and help text

chore: updates the CLI description in docs and help text #325

Workflow file for this run

name: CI
on:
push:
branches: [main]
pull_request:
jobs:
test:
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v6
- uses: actions/setup-go@v6
with:
go-version-file: go.mod
- name: Build
run: make build-all
- name: Test
run: go test -race -timeout 2m ./...
- name: Lint
uses: golangci/golangci-lint-action@v9
with:
version: v2.12
docs:
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v6
- uses: actions/setup-go@v6
with:
go-version-file: go.mod
- name: Generate docs
run: make docs
- name: Check docs are up to date
run: |
if [ -n "$(git status --porcelain docs/)" ]; then
echo "Docs are out of date. Run 'make docs' and commit the result."
git status --porcelain docs/
exit 1
fi