chore: Adding checkbox for changelog updates

[yhakbar]

Description

Updates the template that generates this pull request body placeholder.

We now track changes as formal documentation in the Terragrunt docs site, and we use GitHub draft/ready for review status to signal that work is in-progress.

Also updated the checkboxes to include a call out that all changes are supposed to be backwards compatible, and if they aren't forwards compatible, they should be gated behind a feature flag.

TODOs

Read the Gruntwork contribution guidelines.

• I authored this code entirely myself
• I am submitting code based on open source software (e.g. MIT, MPL-2.0, Apache)
• I am adding or upgrading a dependency or adapted code and confirm it has a compatible open source license
• Update the docs.
• Run the relevant tests successfully, including pre-commit checks.
• Include release notes. If this PR is backward incompatible, include a migration guide.

Release Notes (draft)

Added / Removed / Updated [X].

Migration Guide

Summary by CodeRabbit

• Documentation

  • Updated PR template to ask contributors to keep work-in-progress PRs in draft and mark ready when ready for review.
  • Added a checklist item to ensure the changelog is updated.
  • Replaced prior prompts about draft release notes and migration guides with explicit checkboxes confirming backward compatibility and that any forward-incompatibility is gated behind a feature flag.

• Chores

  • Internal process refinements only; no user-facing changes.

[vercel]

The latest updates on your projects. Learn more about Vercel for GitHub.

Project	Deployment	Actions	Updated (UTC)
terragrunt-docs	Ready	Preview, Comment	May 1, 2026 2:58pm

[coderabbitai]

No actionable comments were generated in the recent review. 🎉

ℹ️ Recent review info

⚙️ Run configuration

Configuration used: Path: .coderabbit.yaml

Review profile: CHILL

Plan: Pro

Run ID: 546969ce-1887-46b0-9d52-e059d87c10d9

📥 Commits

Reviewing files that changed from the base of the PR and between 28defa8 and e4da82e.

📒 Files selected for processing (1)

• .github/pull_request_template.md

✅ Files skipped from review due to trivial changes (1)

• .github/pull_request_template.md

---

📝 Walkthrough

Walkthrough

The pull request template was updated to require changelog updates in the docs and add checkboxes confirming backward compatibility and that any lack of forward compatibility is gated behind a feature flag. Prompts for draft release notes and migration guides were removed.

Changes

Cohort / File(s)	Summary
Pull Request Template ​.github/pull_request_template.md	Updated checklist: require updating the docs changelog; replace prompts for draft release notes and migration guides with confirmation checkboxes for backward compatibility and forward-compatibility gating via feature flags.

Estimated code review effort

🎯 1 (Trivial) | ⏱️ ~2 minutes

🚥 Pre-merge checks | ✅ 4 | ❌ 1

❌ Failed checks (1 warning)

Check name	Status	Explanation	Resolution
Title check	⚠️ Warning	The title 'chore: Adding checkbox for changelog updates' is related to the PR objective but does not accurately reflect the main change, which involves updating the PR template's structure and requirements across multiple areas.	Consider a more comprehensive title like 'chore: Update pull request template with changelog and compatibility requirements' to better capture all significant changes made to the template.

✅ Passed checks (4 passed)

Check name	Status	Explanation
Description check	✅ Passed	The PR description adequately explains the changes to the template, references the shift to documentation tracking and draft/ready status, and mentions the backward compatibility checkbox updates.
Docstring Coverage	✅ Passed	No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.
Linked Issues check	✅ Passed	Check skipped because no linked issues were found for this pull request.
Out of Scope Changes check	✅ Passed	Check skipped because no linked issues were found for this pull request.

_{✏️ Tip: You can configure your own custom pre-merge checks in the settings.}

✨ Finishing Touches

🧪 Generate unit tests (beta)

• Create PR with unit tests
• Commit unit tests in branch chore/adding-checkbox-for-changelog

---

_{Review rate limit: 3/5 reviews remaining, refill in 21 minutes and 16 seconds.}

_{Comment @coderabbitai help to get the list of available commands and usage tips.}

[coderabbitai]

🧹 Nitpick comments (1)

.github/pull_request_template.md (1)

19-20: ⚡ Quick win

Clarify forward-compatibility attestation in the PR checklist

Right now the template has an explicit “backwards compatible” checkbox, but forward compatibility is only handled as a conditional (“if this change is not forwards compatible…”). If the change is forwards compatible, there’s no positive attestation checkbox, which can lead to inconsistent review/compliance.

🛠️ Proposed change

- - [ ] This change is backwards compatible.
- - [ ] If this change is not forwards compatible (e.g. a new feature), it is gated behind a feature flag.
+ - [ ] This change is backwards compatible.
+ - [ ] This change is forwards compatible.
+ - [ ] If this change is not forwards compatible, it is gated behind a feature flag.

🤖 Prompt for AI Agents

Verify each finding against the current code and only fix it if needed.

In @.github/pull_request_template.md around lines 19 - 20, Add an explicit
positive forward-compatibility checkbox to the PR checklist: replace or augment
the existing lines containing "- [ ] This change is backwards compatible." and
"- [ ] If this change is not forwards compatible (e.g. a new feature), it is
gated behind a feature flag." by adding a clear checkbox like " - [ ] This
change is forwards compatible." (and keep the conditional gating checkbox for
non-forward-compatible changes if desired) so reviewers can explicitly attest
forward compatibility.

🤖 Prompt for all review comments with AI agents

Verify each finding against the current code and only fix it if needed.

Nitpick comments:
In @.github/pull_request_template.md:
- Around line 19-20: Add an explicit positive forward-compatibility checkbox to
the PR checklist: replace or augment the existing lines containing "- [ ] This
change is backwards compatible." and "- [ ] If this change is not forwards
compatible (e.g. a new feature), it is gated behind a feature flag." by adding a
clear checkbox like " - [ ] This change is forwards compatible." (and keep the
conditional gating checkbox for non-forward-compatible changes if desired) so
reviewers can explicitly attest forward compatibility.

---

ℹ️ Review info

⚙️ Run configuration

Configuration used: Path: .coderabbit.yaml

Review profile: CHILL

Plan: Pro

Run ID: 42784482-2411-4dab-a876-d2de0cda993b

📥 Commits

Reviewing files that changed from the base of the PR and between 45fe7da and 28defa8.

📒 Files selected for processing (1)

• .github/pull_request_template.md