fix: migrated doc gen to github action #17
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: Generate Docs | |
| on: | |
| pull_request: | |
| branches: | |
| - main | |
| paths-ignore: | |
| - '.github/**/*' | |
| - 'scripts/**/*' | |
| workflow_dispatch: | |
| permissions: | |
| contents: write # Required to update documentation in the repo | |
| pull-requests: write | |
| jobs: | |
| provider-docs: | |
| name: '📚 Generate Go and TF Provider Docs' | |
| runs-on: ubuntu-latest | |
| steps: | |
| - name: Harden Runner | |
| uses: step-security/[email protected] | |
| with: | |
| egress-policy: audit | |
| - uses: actions/[email protected] | |
| with: | |
| ref: ${{ github.event.pull_request.head.ref }} | |
| - uses: actions/[email protected] | |
| with: | |
| cache: true | |
| go-version-file: 'go.mod' | |
| - uses: hashicorp/[email protected] | |
| with: | |
| terraform_version: '1.10.2' | |
| terraform_wrapper: true | |
| # Creates provider documentation for godoc.org and pkg.go.dev | |
| - name: 'go generate' | |
| run: go generate ./... | |
| # Format all Terraform files | |
| - name: Format Terraform files | |
| run: | | |
| find . -type f -name "*.tf" -exec terraform fmt {} \; | |
| # Creates provider documentation for Terraform | |
| - name: Render terraform docs and push changes back to PR | |
| uses: terraform-docs/[email protected] | |
| with: | |
| working-dir: examples/ | |
| git-push: "true" | |
| output-format: markdown document | |
| output-file: USAGE.md | |
| output-method: replace | |
| args: --sensitive=false --hide requirements --required=false | |
| indention: 3 | |
| config-file: .terraform-docs.yml | |
| - name: Check for changes in generated Go docs and formatted Terraform files | |
| id: go-gen-check | |
| run: | | |
| if [[ -n $(git status --porcelain) ]]; then | |
| echo "changes=true" >> $GITHUB_OUTPUT | |
| else | |
| echo "changes=false" >> $GITHUB_OUTPUT | |
| fi | |
| - name: Commit changes in Go + provider docs and Terraform formatting | |
| if: steps.go-gen-check.outputs.changes == 'true' | |
| uses: stefanzweifel/[email protected] | |
| with: | |
| commit_message: "chore: update go documentation, provider documentation and format terraform files" | |
| file_pattern: '**/*.go **/*.tf docs/**/*' | |
| commit_options: '--no-verify --signoff' | |
| commit_user_name: "GitHub Actions Bot" | |
| commit_user_email: "github-actions[bot]@users.noreply.github.com" | |
| commit_author: "GitHub Actions Bot <github-actions[bot]@users.noreply.github.com>" | |
| status_options: '--untracked-files=no' | |
| add_options: '-u' | |
| push_options: '--force' | |
| skip_dirty_check: false | |
| skip_fetch: true | |
| skip_checkout: true |