Terraform Provider Documentation Alignment #8
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: tfplugindocs generate | |
| on: | |
| pull_request: | |
| paths: | |
| - .github/workflows/tfplugindocs-check.yml | |
| - Makefile | |
| - docs/** | |
| - examples/** | |
| - templates/** | |
| - sonarqube/** | |
| jobs: | |
| tfplugindocs_generate: | |
| name: tfplugindocs generate | |
| runs-on: ubuntu-latest | |
| steps: | |
| - uses: actions/checkout@eef61447b9ff4aafe5dcd4e0bbf5d482be7e7871 # v4.2.1 | |
| with: | |
| persist-credentials: false # otherwise, the token used is the GITHUB_TOKEN, instead of your personal token | |
| fetch-depth: 0 # otherwise, you will fail to push refs to dest repo | |
| - 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@3624ceb22c1c5a301c8db4169662070a689d9ea8 # v4.1.1 | |
| continue-on-error: true | |
| timeout-minutes: 2 | |
| with: | |
| path: ${{ env.GOCACHE }} | |
| key: ${{ runner.os }}-GOCACHE-${{ hashFiles('go.sum') }}-${{ hashFiles('internal/**') }} | |
| - uses: actions/cache@3624ceb22c1c5a301c8db4169662070a689d9ea8 # v4.1.1 | |
| 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 | |
| - uses: actions-js/push@5a7cbd780d82c0c937b5977586e641b2fd94acc5 #v1.5 | |
| name: Github commit and push | |
| with: | |
| github_token: ${{ secrets.GITHUB_TOKEN }} | |
| branch: ${{ github.head_ref }} | |
| message: "[bot] docs: tfplugindocs generate" |