chore: add help make target #3317
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 if tfplugindocs result matches /docs | |
| on: | |
| push: | |
| branches: | |
| - main | |
| - "release/**" | |
| pull_request: | |
| paths: | |
| - .github/workflows/tfplugindocs-check.yml | |
| - .golangci.yml | |
| - go.sum | |
| - GNUmakefile | |
| - internal/** | |
| - main.go | |
| - tools/** | |
| - docs/** | |
| jobs: | |
| tfplugindocs_check: | |
| name: tfplugindocs check | |
| runs-on: ubuntu-latest | |
| steps: | |
| - uses: actions/checkout@eef61447b9ff4aafe5dcd4e0bbf5d482be7e7871 # v4.2.1 | |
| - uses: actions/setup-go@0a12ed9d6a96ab950c8f026ed9f722fe0da7ef32 # v5.0.2 | |
| with: | |
| go-version-file: tools/go.mod | |
| - name: GOCACHE | |
| run: | | |
| echo "GOCACHE=$(go env GOCACHE)" >> $GITHUB_ENV | |
| - uses: actions/cache@2cdf405574d6ef1f33a1d12acccd3ae82f47b3f2 # v4.1.0 | |
| continue-on-error: true | |
| timeout-minutes: 2 | |
| with: | |
| # TODO: Replace with supported mechanism when it is supported | |
| # https://github.com/actions/setup-go/issues/54 | |
| path: ${{ env.GOCACHE }} | |
| key: ${{ runner.os }}-GOCACHE-${{ hashFiles('go.sum') }}-${{ hashFiles('internal/**') }} | |
| - uses: actions/cache@2cdf405574d6ef1f33a1d12acccd3ae82f47b3f2 # v4.1.0 | |
| continue-on-error: true | |
| timeout-minutes: 2 | |
| with: | |
| path: ~/go/pkg/mod | |
| key: ${{ runner.os }}-go-pkg-mod-${{ hashFiles('go.sum') }} | |
| - run: | | |
| make tools | |
| make docs | |
| git add -N docs/ | |
| git diff --exit-code |