break up docs #14
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: 'Terraform Plan' | |
| on: | |
| pull_request: | |
| env: | |
| TF_CLOUD_ORGANIZATION: "florenciacomuzzi-org" # template field | |
| TF_API_TOKEN: "${{ secrets.TF_API_TOKEN }}" | |
| TF_WORKSPACE: "production" # template field | |
| CONFIG_DIRECTORY: "./" | |
| jobs: | |
| tflint: | |
| name: "TFLint" | |
| runs-on: ${{ matrix.os }} | |
| strategy: | |
| matrix: | |
| os: [ubuntu-latest, macos-latest, windows-latest] | |
| steps: | |
| - uses: actions/checkout@v4 | |
| name: Checkout source code | |
| - uses: actions/cache@v4 | |
| name: Cache plugin dir | |
| with: | |
| path: ~/.tflint.d/plugins | |
| key: ${{ matrix.os }}-tflint-${{ hashFiles('.tflint.hcl') }} | |
| - uses: terraform-linters/setup-tflint@v4 | |
| name: Setup TFLint | |
| with: | |
| tflint_version: v0.52.0 | |
| - name: Show version | |
| run: tflint --version | |
| - name: Init TFLint | |
| run: tflint --init | |
| env: | |
| # https://github.com/terraform-linters/tflint/blob/master/docs/user-guide/plugins.md#avoiding-rate-limiting | |
| GITHUB_TOKEN: ${{ github.token }} | |
| - name: Run TFLint | |
| run: tflint -f compact | |
| terraform: | |
| if: github.repository != 'hashicorp-education/learn-terraform-github-actions' | |
| name: "Terraform Plan" | |
| runs-on: ubuntu-latest | |
| permissions: | |
| contents: read | |
| pull-requests: write | |
| steps: | |
| - name: Checkout | |
| uses: actions/checkout@v4 | |
| - name: Upload Configuration | |
| uses: hashicorp/tfc-workflows-github/actions/upload-configuration@v1.0.0 | |
| id: plan-upload | |
| with: | |
| workspace: ${{ env.TF_WORKSPACE }} | |
| directory: ${{ env.CONFIG_DIRECTORY }} | |
| speculative: true | |
| - name: Create Plan Run | |
| uses: hashicorp/tfc-workflows-github/actions/create-run@v1.0.0 | |
| id: plan-run | |
| with: | |
| workspace: ${{ env.TF_WORKSPACE }} | |
| configuration_version: ${{ steps.plan-upload.outputs.configuration_version_id }} | |
| plan_only: true | |
| - name: Get Plan Output | |
| uses: hashicorp/tfc-workflows-github/actions/plan-output@v1.0.0 | |
| id: plan-output | |
| with: | |
| plan: ${{ fromJSON(steps.plan-run.outputs.payload).data.relationships.plan.data.id }} | |
| - name: Update PR | |
| uses: actions/github-script@v6 | |
| id: plan-comment | |
| with: | |
| github-token: ${{ secrets.GITHUB_TOKEN }} | |
| script: | | |
| // 1. Retrieve existing bot comments for the PR | |
| const { data: comments } = await github.rest.issues.listComments({ | |
| owner: context.repo.owner, | |
| repo: context.repo.repo, | |
| issue_number: context.issue.number, | |
| }); | |
| const botComment = comments.find(comment => { | |
| return comment.user.type === 'Bot' && comment.body.includes('HCP Terraform Plan Output') | |
| }); | |
| const output = `#### HCP Terraform Plan Output | |
| \`\`\` | |
| Plan: ${{ steps.plan-output.outputs.add }} to add, ${{ steps.plan-output.outputs.change }} to change, ${{ steps.plan-output.outputs.destroy }} to destroy. | |
| \`\`\` | |
| [HCP Terraform Plan](${{ steps.plan-run.outputs.run_link }}) | |
| `; | |
| // 3. Delete previous comment so PR timeline makes sense | |
| if (botComment) { | |
| github.rest.issues.deleteComment({ | |
| owner: context.repo.owner, | |
| repo: context.repo.repo, | |
| comment_id: botComment.id, | |
| }); | |
| } | |
| github.rest.issues.createComment({ | |
| issue_number: context.issue.number, | |
| owner: context.repo.owner, | |
| repo: context.repo.repo, | |
| body: output | |
| }); |