docs(release-notes): tell pre-zero-touch federation bundle customers to re-download#64
Conversation
…to re-download Customers who downloaded a federation IaC bundle before the zero-touch registration fix landed on 2026-04-22 keep their old copy, which silently skips auto-registration unless manually edited. Old bundles had: - Terraform `registration.tf` gating `do_register` on `contact_email` - CLI shell scripts gating the registration call on `CUDLY_CONTACT_EMAIL` - CloudFormation deploy scripts with no registration curl call at all The fix only takes effect in bundles downloaded after it ships, and there is no way to back-fix already-downloaded files. Add a Notices subsection under `[Unreleased]` in CHANGELOG.md telling affected customers to re-download the bundle from the CUDly UI. Tracked in `known_issues/27_federation_old_bundle_redownload_notice.md`. Closes #43
|
Important Review skippedAuto reviews are disabled on base/target branches other than the default branch. Please check the settings in the CodeRabbit UI or the ⚙️ Run configurationConfiguration used: defaults Review profile: CHILL Plan: Pro Run ID: You can disable this status message by setting the Use the checkbox below for a quick retry:
📝 WalkthroughWalkthroughA release-notes notice is added to CHANGELOG.md advising customers that federation Infrastructure-as-Code bundles downloaded before the zero-touch registration feature must be re-downloaded to enable automatic account registration without manual configuration edits. Changes
Estimated code review effort🎯 1 (Trivial) | ⏱️ ~2 minutes Poem
🚥 Pre-merge checks | ✅ 5✅ Passed checks (5 passed)
✏️ Tip: You can configure your own custom pre-merge checks in the settings. ✨ Finishing Touches🧪 Generate unit tests (beta)
Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out. Comment |
|
@coderabbitai review |
✅ Actions performedReview triggered.
|
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
Actionable comments posted: 1
🤖 Prompt for all review comments with AI agents
Verify each finding against the current code and only fix it if needed.
Inline comments:
In `@CHANGELOG.md`:
- Around line 12-15: Update the CHANGELOG notice to correct the gating
variables: replace references to contact_email and CUDLY_CONTACT_EMAIL with
cudly_api_url and CUDLYAPIURL to match the actual implementation; ensure the
sentence that currently reads "...gated `do_register` on `contact_email`; CLI
shell scripts gated the registration call on `CUDLY_CONTACT_EMAIL`" is rewritten
to reference `cudly_api_url` and `CUDLYAPIURL` respectively so the wording
aligns with the code paths (see the registration Terraform logic and the
templates_test.go expectations).
🪄 Autofix (Beta)
Fix all unresolved CodeRabbit comments on this PR:
- Push a commit to this branch (recommended)
- Create a new PR with the fixes
| skip auto-registration unless manually edited (Terraform `registration.tf` | ||
| gated `do_register` on `contact_email`; CLI shell scripts gated the | ||
| registration call on `CUDLY_CONTACT_EMAIL`; CloudFormation deploy scripts | ||
| had no registration call at all). Re-download the bundle from the CUDly |
There was a problem hiding this comment.
Correct the gate-condition details in the notice.
On Line 13 and Line 14, the described gating conditions don’t match the implementation shown in iac/federation/aws-target/terraform/registration.tf:1-14 and internal/iacfiles/templates_test.go:203-221.
Both Terraform and CLI auto-registration are gated by presence of cudly_api_url / CUDlyAPIURL, not contact_email / CUDLY_CONTACT_EMAIL.
Proposed wording tweak
-- skip auto-registration unless manually edited (Terraform `registration.tf`
-- gated `do_register` on `contact_email`; CLI shell scripts gated the
-- registration call on `CUDLY_CONTACT_EMAIL`; CloudFormation deploy scripts
+- skip auto-registration unless manually edited (Terraform `registration.tf`
+- gated `do_register` on `cudly_api_url`; CLI shell scripts included the
+- registration call only when `CUDlyAPIURL` was present; CloudFormation deploy scripts📝 Committable suggestion
‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation. Thoroughly test & benchmark the code to ensure it meets the requirements.
| skip auto-registration unless manually edited (Terraform `registration.tf` | |
| gated `do_register` on `contact_email`; CLI shell scripts gated the | |
| registration call on `CUDLY_CONTACT_EMAIL`; CloudFormation deploy scripts | |
| had no registration call at all). Re-download the bundle from the CUDly | |
| skip auto-registration unless manually edited (Terraform `registration.tf` | |
| gated `do_register` on `cudly_api_url`; CLI shell scripts included the | |
| registration call only when `CUDlyAPIURL` was present; CloudFormation deploy scripts | |
| had no registration call at all). Re-download the bundle from the CUDly |
🤖 Prompt for AI Agents
Verify each finding against the current code and only fix it if needed.
In `@CHANGELOG.md` around lines 12 - 15, Update the CHANGELOG notice to correct
the gating variables: replace references to contact_email and
CUDLY_CONTACT_EMAIL with cudly_api_url and CUDLYAPIURL to match the actual
implementation; ensure the sentence that currently reads "...gated `do_register`
on `contact_email`; CLI shell scripts gated the registration call on
`CUDLY_CONTACT_EMAIL`" is rewritten to reference `cudly_api_url` and
`CUDLYAPIURL` respectively so the wording aligns with the code paths (see the
registration Terraform logic and the templates_test.go expectations).
…ownload notice Addresses CodeRabbit nitpick on PR #64. The Notices entry described the old bundles as gating registration on `contact_email` (Terraform) and `CUDLY_CONTACT_EMAIL` (CLI), but the actual gates are `cudly_api_url` and `CUDlyAPIURL` respectively: - iac/federation/aws-target/terraform/registration.tf:1 — `do_register = var.cudly_api_url != ""`. - internal/iacfiles/templates/aws-cross-account-cli.sh.tmpl:83 — `{{- if .CUDlyAPIURL}}` gates the entire register block. - internal/iacfiles/templates_test.go:205 — `TestCLITemplatesOmitRegisterBlock` pins this contract. The `contact_email` field still exists in the bundles but is the email *sent* in the registration body — not the gate that decides whether registration runs at all.
|
Addressed CodeRabbit's actionable nitpick in
|
cristim
added
triaged
1 participant
Summary
Adds a
Noticessubsection under[Unreleased]inCHANGELOG.mdinforming customers that federation IaC bundles downloaded before the zero-touch registration fix landed on 2026-04-22 need to be re-downloaded to get auto-registration. Old bundles silently skip registration unless manually edited.Why
The zero-touch registration fix (commit
3b4dc5108 fix(federation): zero-touch self-registration across all IaC formats) only takes effect in bundles downloaded after the fix shipped — there's no way to back-fix files customers already have on disk. Without this notice, affected customers completeterraform apply/ shell-script deploys with no error and then wonder why their account never appears in CUDly.Old bundles included:
registration.tfwithdo_register = var.cudly_api_url != "" && var.contact_email != ""if [[ -n "${CUDLY_CONTACT_EMAIL:-}" ]]; then ...Tracked in
known_issues/27_federation_old_bundle_redownload_notice.md.Test plan
cat CHANGELOG.md— markdown renders cleanly,### Noticessubsection sits above### Fixedunder[Unreleased].Lint Markdown filespassed).Closes #43
Summary by CodeRabbit