Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
55 changes: 53 additions & 2 deletions .github/workflows/terraform-stack.yml
Original file line number Diff line number Diff line change
Expand Up @@ -49,6 +49,10 @@ on:
runner:
type: string
default: linux-arm64
dismiss-stale-approvals:
description: On a pull request, dismiss approvals given on a commit whose plan for this stack differs from the new plan.
type: boolean
default: false
secrets:
aws-access-key-id:
required: false
Expand Down Expand Up @@ -189,12 +193,34 @@ jobs:
AWS_REGION: ${{ steps.store.outputs.region || inputs.aws-region }}
run: aws s3 cp --only-show-errors tfplan "$URI"

- name: Fingerprint the planned changes
id: fingerprint
if: inputs.command == 'plan' && inputs.dismiss-stale-approvals && github.event_name == 'pull_request' && steps.plan.outputs.failed != 'true'
run: |
set -eu
hash=$(terraform show -json tfplan | jq -cS '
def mask($s):
if $s == true then "(sensitive)"
elif type == "object" and ($s | type) == "object" then with_entries(.key as $k | .value |= mask($s[$k] // false))
elif type == "array" and ($s | type) == "array" then [range(0; length) as $i | .[$i] | mask($s[$i] // false)]
else . end;
[.resource_changes[]?
| .change as $c
| select($c.actions != ["no-op"] and $c.actions != ["read"])
| {address, actions: $c.actions, after: ($c.after | mask($c.after_sensitive // false)),
after_unknown: $c.after_unknown, replace_paths: $c.replace_paths, importing: $c.importing}]
| sort_by(.address)' | sha256sum | cut -d' ' -f1)
echo "hash=$hash" >> "$GITHUB_OUTPUT"
echo "Plan fingerprint: $hash"

- name: Comment plan on the pull request
if: inputs.command == 'plan' && github.event_name == 'pull_request'
uses: actions/github-script@3a2844b7e9c422d3c10d287c895573f7108da1b3 # v9
env:
PLAN_FAILED: ${{ steps.plan.outputs.failed }}
HAS_CHANGES: ${{ steps.plan.outputs.changes }}
FINGERPRINT: ${{ steps.fingerprint.outputs.hash }}
HEAD_SHA: ${{ github.event.pull_request.head.sha }}
with:
script: |
const fs = require('fs')
Expand Down Expand Up @@ -257,9 +283,34 @@ jobs:
owner, repo, issue_number: context.issue.number, per_page: 100,
})
const existing = comments.find(c => c.body.includes(marker))

const fingerprint = process.env.FINGERPRINT
const seen = new Map([...(existing?.body ?? '').matchAll(/^<!-- terraform-plan-fingerprint:(\w+):(\w+) -->$/gm)].map(m => [m[1], m[2]]))
if (fingerprint) {
seen.delete(process.env.HEAD_SHA)
seen.set(process.env.HEAD_SHA, fingerprint)
}
const full = [body, ...[...seen].slice(-50).map(([sha, fp]) => `<!-- terraform-plan-fingerprint:${sha}:${fp} -->`)].join('\n')
existing
? await github.rest.issues.updateComment({ owner, repo, comment_id: existing.id, body })
: await github.rest.issues.createComment({ owner, repo, issue_number: context.issue.number, body })
? await github.rest.issues.updateComment({ owner, repo, comment_id: existing.id, body: full })
: await github.rest.issues.createComment({ owner, repo, issue_number: context.issue.number, body: full })

if (fingerprint) {
const pull_number = context.issue.number
const reviews = await github.paginate(github.rest.pulls.listReviews, { owner, repo, pull_number, per_page: 100 })
const latest = new Map()
for (const r of reviews) if (r.state !== 'COMMENTED' && r.state !== 'PENDING') latest.set(r.user.id, r)
for (const r of latest.values()) {
if (r.state !== 'APPROVED') continue
const approved = seen.get(r.commit_id)
if (approved === fingerprint) continue
const message = approved
? `The plan for ${stack} changed since this approval (${r.commit_id.slice(0, 7)}). Review the new plan and approve again.`
: `No plan for ${stack} was recorded on the approved commit (${r.commit_id.slice(0, 7)}), so this approval cannot be matched to the new plan. Review it and approve again.`
await github.rest.pulls.dismissReview({ owner, repo, pull_number, review_id: r.id, message })
core.notice(`Dismissed ${r.user.login}'s approval: ${message}`)
}
}

- name: Fail on plan error
if: steps.plan.outputs.failed == 'true'
Expand Down
2 changes: 2 additions & 0 deletions docs/workflow-guide.md
Original file line number Diff line number Diff line change
Expand Up @@ -1416,6 +1416,8 @@ A change inside a local module selects every stack that calls that module, direc

Optional per-stack inputs on `terraform-stack.yml`: `tailscale: true` (with the `tailscale-authkey` secret) joins the tailnet before init, for providers that talk to private endpoints such as a database; `parallelism` sets Terraform's `-parallelism` for plan and apply; `aws-session-duration` lengthens the OIDC session for applies that run past an hour (the role's `MaxSessionDuration` must allow it). Discovery passes any extra key on an `accounts[]` entry through to the matrix, so these can be set per path prefix.

`dismiss-stale-approvals: true` makes an approval cover a plan, not a commit. Each plan records a fingerprint of its planned changes (address, actions and non-sensitive values, ignoring no-ops and drift) in the plan comment. When a new plan's fingerprint differs from the one on the approved commit, for example after a rebase that pulled in another stack change, the approval is dismissed and someone has to review the new plan. A rebase that leaves the plan unchanged keeps the approval.

Each stack needs `.terraform-version` (its own, or one at the repository root) and a committed `.terraform.lock.hcl`. Generate the lock file for the runner architecture:

```bash
Expand Down