Prepare Module for Publishing (#12) #5
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-terraform-docs | |
| # This workflow will generate terraform docs into README.md in the root, examples, and modules folders. | |
| # Source: https://github.com/equinix-labs/terraform-equinix-kubernetes-addons/blob/main/.github/workflows/documentation.yaml | |
| on: | |
| push: | |
| branches: | |
| - main | |
| paths: | |
| - '**/*.tpl' | |
| - '**/*.tf' | |
| jobs: | |
| tf-docs: | |
| name: TF docs | |
| runs-on: ubuntu-latest | |
| steps: | |
| - uses: actions/checkout@8ade135a41bc03ea155e62e844d188df1ea18608 # v4 | |
| id: actions-checkout | |
| with: | |
| ref: main | |
| - name: Render terraform docs inside the main and the modules README.md files and push changes back to PR branch | |
| id: terraform-docs | |
| uses: terraform-docs/[email protected] | |
| with: | |
| find-dir: . | |
| args: --sort-by required | |
| indention: 2 | |
| git-push: "false" | |
| # terraform-docs/[email protected] modifies .git files with owner root:root, and the following steps fail with | |
| # insufficient permission for adding an object to repository database .git/objects | |
| # since the expected user is runner:docker. See https://github.com/terraform-docs/gh-actions/issues/90 | |
| - name: Fix .git owner | |
| run: sudo chown runner:docker -R .git | |
| - name: Create Pull Request | |
| if: steps.terraform-docs.outputs.num_changed != '0' | |
| uses: peter-evans/create-pull-request@v5 | |
| with: | |
| commit-message: 'generate-terraform-docs: automated action' | |
| committer: GitHub <[email protected]> | |
| author: ${{ github.actor }} <${{ github.actor }}@users.noreply.github.com> | |
| title: 'generate-terraform-docs: automated action' | |
| body: | | |
| Update terraform docs | |
| branch-suffix: timestamp | |
| base: main | |
| signoff: true | |
| delete-branch: true | |
| # TODO(ocobleseqx): https://github.com/peter-evans/enable-pull-request-automerge |