docs: improve grammar, clarity, and code examples and API docs #178
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: Go test and lint | |
| on: | |
| pull_request: | |
| branches: 'master' | |
| jobs: | |
| go-test-lint: | |
| strategy: | |
| matrix: | |
| go: [1.22, 1.23] | |
| golangcli: [v1.61.0] | |
| os: [ubuntu-latest] | |
| runs-on: ${{ matrix.os }} | |
| steps: | |
| - name: Checkout | |
| uses: actions/checkout@v4 | |
| - name: Set up Go | |
| uses: actions/setup-go@v5 | |
| with: | |
| go-version: ${{ matrix.go }} | |
| cache: true | |
| - name: Validate go mod / generate | |
| run: | | |
| go mod tidy | |
| go install golang.org/x/tools/cmd/stringer@latest | |
| go generate ./... | |
| git --no-pager diff && [[ 0 -eq $(git status --porcelain | wc -l) ]] | |
| - name: Go Lint | |
| uses: golangci/golangci-lint-action@v4 | |
| with: | |
| version: ${{ matrix.golangcli }} | |
| args: --out-format=colored-line-number | |
| skip-pkg-cache: true | |
| skip-build-cache: true | |
| - name: Go Build | |
| run: go build ./... | |
| - name: Go Test | |
| run: go test -race -v ./... |