Add docs check #430
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: Cockroach Terraform Provider CI | |
| on: | |
| pull_request: | |
| branches: | |
| - 'main' | |
| jobs: | |
| # pre job run golangci-lint | |
| go-lint: | |
| name: 'Golint' | |
| runs-on: ubuntu-latest | |
| steps: | |
| - name: Setup Go | |
| uses: actions/setup-go@v5 | |
| with: | |
| go-version: 1.21 | |
| - name: Checkout sources | |
| uses: actions/checkout@v4 | |
| with: | |
| ref: ${{github.event.pull_request.head.ref}} | |
| repository: ${{github.event.pull_request.head.repo.full_name}} | |
| - name: Run golangci-lint | |
| uses: golangci/golangci-lint-action@v4 | |
| with: | |
| version: v1.56.2 | |
| working-directory: . | |
| args: --timeout=5m | |
| # pre job to run tests | |
| integration-test: | |
| name: integration-test | |
| runs-on: ubuntu-latest | |
| steps: | |
| - name: Checkout sources | |
| uses: actions/checkout@v4 | |
| with: | |
| ref: ${{github.event.pull_request.head.ref}} | |
| repository: ${{github.event.pull_request.head.repo.full_name}} | |
| - name: Setup Go | |
| uses: actions/setup-go@v5 | |
| with: | |
| go-version: 1.21 | |
| - name: Tests | |
| run: make test | |
| # pre job to build terraform-provider on every pull request | |
| pre-build: | |
| name: build-terraform-provider | |
| runs-on: ubuntu-latest | |
| steps: | |
| - name: Checkout sources | |
| uses: actions/checkout@v4 | |
| - name: Setup Go | |
| uses: actions/setup-go@v5 | |
| with: | |
| go-version: 1.21 | |
| - name: Build terraform-provider | |
| run: make install | |
| docs-check: | |
| name: docs-generated-check | |
| runs-on: ubuntu-latest | |
| steps: | |
| - name: Checkout sources | |
| uses: actions/checkout@v4 | |
| - name: Build docs | |
| run: make generate | |
| - name: Get changed files | |
| id: changed-files | |
| run: | | |
| echo "changed_files=$(git diff --name-only | xargs)" >> $GITHUB_OUTPUT | |
| - name: List changed files | |
| run: | | |
| if [ "${#steps.changed-files.outputs.changed_files[@]}" -gt "0" ]; then | |
| echo "Unexpected changes found in the repo, did you remember to run `make generate`?" > $GITHUB_STEP_SUMMARY | |
| echo "Changed files:" >> $GITHUB_STEP_SUMMARY | |
| for file in ${{ steps.changed-files.outputs.changed_files }}; do | |
| echo "`$file`" >> $GITHUB_STEP_SUMMARY | |
| done | |
| exit 1 | |
| fi |