chore: update readme #19
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: | |
| branches: [main] | |
| workflow_call: | |
| permissions: | |
| contents: read | |
| jobs: | |
| lint: | |
| runs-on: ubuntu-latest | |
| steps: | |
| - uses: actions/checkout@v4 | |
| - uses: actions/setup-go@v5 | |
| with: | |
| go-version-file: go.mod | |
| cache: true | |
| - name: Format check | |
| run: test -z "$(gofmt -l ./cmd ./internal)" | |
| - name: Vet | |
| run: go vet ./... | |
| test: | |
| runs-on: ubuntu-latest | |
| steps: | |
| - uses: actions/checkout@v4 | |
| - uses: actions/setup-go@v5 | |
| with: | |
| go-version-file: go.mod | |
| cache: true | |
| - name: Unit tests | |
| env: | |
| MDPROOF_ALLOW_EXECUTE: "1" | |
| run: go test -race -coverprofile=coverage.out ./... | |
| build: | |
| runs-on: ubuntu-latest | |
| steps: | |
| - uses: actions/checkout@v4 | |
| - uses: actions/setup-go@v5 | |
| with: | |
| go-version-file: go.mod | |
| cache: true | |
| - name: Build | |
| run: go build -o bin/mdproof ./cmd/mdproof | |
| dogfood: | |
| runs-on: ubuntu-latest | |
| steps: | |
| - uses: actions/checkout@v4 | |
| - uses: actions/setup-go@v5 | |
| with: | |
| go-version-file: go.mod | |
| cache: true | |
| - name: Build | |
| run: go build -o bin/mdproof ./cmd/mdproof | |
| - name: Dogfood — run fixture runbooks | |
| env: | |
| MDPROOF_ALLOW_EXECUTE: "1" | |
| run: | | |
| bin/mdproof \ | |
| runbooks/fixtures/hello-proof.md \ | |
| runbooks/fixtures/multi-step-proof.md \ | |
| runbooks/fixtures/with-exit-code-proof.md \ | |
| runbooks/fixtures/with-regex-proof.md \ | |
| runbooks/fixtures/with-negated-proof.md \ | |
| runbooks/fixtures/with-directives-proof.md \ | |
| runbooks/fixtures/verbose-proof.md | |
| - name: Dogfood — snapshot runbook | |
| env: | |
| MDPROOF_ALLOW_EXECUTE: "1" | |
| run: | | |
| bin/mdproof -u runbooks/fixtures/with-snapshot-proof.md | |
| bin/mdproof runbooks/fixtures/with-snapshot-proof.md | |
| - name: Dogfood — inline testing | |
| env: | |
| MDPROOF_ALLOW_EXECUTE: "1" | |
| run: bin/mdproof --inline runbooks/fixtures/with-inline.md |