Skip to content

docs(upgrading): say which kustomize panics on an invalid images: name - #416

Merged
sunib merged 1 commit into
mainfrom
fix-upgrading-invalid-image-name
Oct 6, 2026
Merged

sunib merged 1 commit into
mainfrom
fix-upgrading-invalid-image-name

Conversation

@sunib

@sunib sunib commented Oct 6, 2026 •

Copy link
Copy Markdown
Contributor

Description

docs/UPGRADING.md said kustomize panics inside the build on an images: entry like - name: "ngin[". Since #415 the analyzer builds with kustomize api v0.21.2, which treats an uncompilable name as matching nothing. Flux's kustomize-controller (v1.9.6) still pins v0.21.1, which panics. The refusal is unchanged; the entry now gives the reason that holds for both.

This also gives release-please a visible commit after #415 (a hidden chore), so it regenerates the 0.52.0 release PR #414 on top of the metricnames.sh lint fix.

Type of Change

  • Documentation update

Testing

  • task lint-docs passes

🤖 Generated with Claude Code

Summary by CodeRabbit

  • Documentation
    • Clarified how invalid images[].name regular expressions behave across kustomize versions, including that the folder is refused before the build.

The entry said kustomize panics inside the build on `- name: "ngin["`.
Since kustomize api v0.21.2, which the analyzer now builds with, it treats
an uncompilable name as matching nothing instead. Flux's kustomize-controller
still pins v0.21.1 and still panics. The refusal is unchanged; the entry now
gives the reason that holds for both.

Co-Authored-By: Claude Opus 5.5 (1M context) <noreply@anthropic.com>
@sunib
sunib force-pushed the fix-upgrading-invalid-image-name branch from 0786a15 to c11145a Compare October 6, 2026 05:54
@coderabbitai

coderabbitai Bot commented Oct 6, 2026 •

Copy link
Copy Markdown

Review in Change Stack →

No actionable comments were generated in the recent review. 🎉

ℹ️ Recent review info
⚙️ Run configuration
  • Configuration used: defaults
  • Review profile: CHILL
  • Plan: Advanced
  • Run ID: 77a043ec-7409-4316-a637-3cee59c88d21
📥 Commits

Reviewing files that changed from the base of the PR and between d010e55 and c11145a.

📒 Files selected for processing (1)
  • docs/UPGRADING.md

Included review availability: This review used your included allowance. Your plan provides up to 1 included review per hour; 0 remain after this review.


📝 Walkthrough

Walkthrough

The upgrading guide clarifies invalid images[].name regex behavior across kustomize API versions. It also states that the folder is refused before the build and that ngin. matches nginx.

Changes

Upgrading guide

Layer / File(s) Summary
Version-specific regex behavior
docs/UPGRADING.md
The guide says invalid patterns can cause a panic through api v0.21.1 and match nothing from v0.21.2. It also clarifies that the folder is refused before the build and that ngin. matches nginx.

Priority: ⬇️ Low

Estimated code review effort: 1 (Trivial) | ~2 minutes

Change: Other

Merge Risk: ⚪ Minimal · up to c1114

The guide accurately explains the invalid-regex behavior for the relevant Kustomize versions and the unchanged pre-build refusal; no merge-blocking documentation issue remains.

Architecture Summary

Architecture risk: 🔵 Low · up to c1114

The change affects 1 system.

Changed systems: docs

Architecture concerns
No architecture-level concerns identified.

Review details

Systems and components

  • observed — docs (service) was modified; 1 changed file maps to changed impact.

Before / after behavior

  • observed — Modified behavior in docs/UPGRADING.md: Clarifies that invalid regex patterns may panic with kustomize through api v0.21.1, but match nothing from v0.21.2; the folder is refused before build in either case. Also clarifies that ngin. matches nginx.
🚥 Pre-merge checks | ✅ 5
✅ Passed checks (5 passed)
Check name Status Explanation
Title check ✅ Passed The title clearly and concisely describes the main change: clarifying which kustomize version panics on an invalid image name.
Description check ✅ Passed The description explains the documentation change and includes the change type and reported test result. It omits the Checklist, Related Issues, and Additional Notes sections, but the core information…
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check. Docstring coverage is scoped to functions touched by this diff. Analyzed 0 functions across 0…
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.
✨ Finishing Touches
🧪 Generate unit tests (beta)
  • Commit to this branch
  • Create a new PR
  • Autopilot · Keep fixing CodeRabbit findings and required CI, and resolving merge conflicts

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.

❤️ Share

Comment @coderabbitai help to get the list of available commands.

@codecov

codecov Bot commented Oct 6, 2026

Copy link
Copy Markdown

Codecov Report

✅ All modified and coverable lines are covered by tests.

📢 Thoughts on this report? Let us know!

@sunib
sunib merged commit 2e656de into main Oct 6, 2026
23 checks passed
@sunib
sunib deleted the fix-upgrading-invalid-image-name branch October 6, 2026 08:33
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant