docs: give the project a front page and a generated CLI reference #79
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| name: ci | |
| on: | |
| push: | |
| branches: [main] | |
| pull_request: | |
| permissions: | |
| contents: read | |
| concurrency: | |
| group: ci-${{ github.ref }} | |
| cancel-in-progress: true | |
| jobs: | |
| build: | |
| runs-on: ubuntu-latest | |
| steps: | |
| - uses: actions/checkout@v5 | |
| - uses: actions/setup-go@v6 | |
| with: | |
| go-version-file: go.mod | |
| cache: true | |
| - run: go build ./... | |
| - run: go vet ./... | |
| - run: go test -race ./... | |
| - run: gofmt -l . | tee /dev/stderr | (! read) | |
| - name: The CLI reference matches the CLI | |
| run: | | |
| go run ./cmd/marstack docs --out docs/cli.md | |
| git diff --exit-code -- docs/cli.md | |
| portable: | |
| runs-on: ubuntu-latest | |
| steps: | |
| - uses: actions/checkout@v5 | |
| - uses: actions/setup-go@v6 | |
| with: | |
| go-version-file: go.mod | |
| cache: true | |
| - run: GOOS=darwin GOARCH=arm64 go build ./... | |
| - run: GOOS=linux GOARCH=amd64 go build ./... | |
| security: | |
| runs-on: ubuntu-latest | |
| steps: | |
| - uses: actions/checkout@v5 | |
| with: | |
| fetch-depth: 0 | |
| - uses: actions/setup-go@v6 | |
| with: | |
| go-version-file: go.mod | |
| cache: true | |
| - name: govulncheck | |
| run: | | |
| go install golang.org/x/vuln/cmd/govulncheck@latest | |
| govulncheck ./... | |
| - name: staticcheck | |
| run: | | |
| go install honnef.co/go/tools/cmd/staticcheck@latest | |
| staticcheck ./... | |
| - name: gosec | |
| run: | | |
| go install github.com/securego/gosec/v2/cmd/gosec@latest | |
| gosec -severity medium -confidence medium -exclude=G124,G204,G301,G302,G304,G306,G703 ./... | |
| - name: gitleaks | |
| run: | | |
| go install github.com/zricethezav/gitleaks/v8@latest | |
| gitleaks git --no-banner --redact |