feat(docs): generate cli docs directly from the struct #3369
Workflow file for this run
This file contains 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: Check | |
on: | |
pull_request: | |
push: | |
branches: | |
- master | |
- release/* | |
workflow_dispatch: | |
defaults: | |
run: | |
shell: bash | |
concurrency: | |
group: ${{ github.workflow }}-${{ github.ref }} | |
cancel-in-progress: ${{ github.event_name == 'pull_request' }} | |
permissions: | |
contents: read | |
jobs: | |
check-gen: | |
name: Check (gen-check) | |
runs-on: ubuntu-latest | |
steps: | |
- uses: actions/checkout@v4 | |
with: | |
submodules: 'recursive' | |
fetch-depth: 0 | |
- uses: ./.github/actions/install-system-dependencies | |
- uses: ./.github/actions/install-go | |
- uses: ./.github/actions/make-deps | |
- run: make gen | |
- run: git diff --exit-code | |
- run: make docsgen-cli | |
- run: git diff --exit-code | |
check-lint: | |
name: Check (lint-all) | |
runs-on: ubuntu-latest | |
steps: | |
- uses: actions/checkout@v4 | |
with: | |
submodules: 'recursive' | |
fetch-depth: 0 | |
- uses: ./.github/actions/install-system-dependencies | |
- uses: ./.github/actions/install-go | |
- uses: ./.github/actions/make-deps | |
- run: go install github.com/golangci/golangci-lint/cmd/golangci-lint@v1.59.0 | |
- run: golangci-lint run -v --timeout 10m --concurrency 4 | |
check-fmt: | |
name: Check (gofmt) | |
runs-on: ubuntu-latest | |
steps: | |
- uses: actions/checkout@v4 | |
with: | |
submodules: 'recursive' | |
fetch-depth: 0 | |
- uses: ./.github/actions/install-go | |
- run: go fmt ./... | |
- run: git diff --exit-code | |
check-mod-tidy: | |
name: Check (mod-tidy-check) | |
runs-on: ubuntu-latest | |
steps: | |
- uses: actions/checkout@v4 | |
with: | |
submodules: 'recursive' | |
fetch-depth: 0 | |
- uses: ./.github/actions/install-go | |
- run: go mod tidy -v | |
- run: git diff --exit-code |