Conversation
WalkthroughVersion bump for the Regions chart from 3.6.9 to 3.7.0, with documentation updates reflecting new configuration options, dependency declarations, and expanded value definitions across chart metadata. Changes
Estimated code review effort🎯 2 (Simple) | ⏱️ ~10 minutes Poem
🚥 Pre-merge checks | ✅ 2 | ❌ 1❌ Failed checks (1 inconclusive)
✅ Passed checks (2 passed)
✏️ Tip: You can configure your own custom pre-merge checks in the settings. ✨ Finishing touches🧪 Generate unit tests (beta)
Comment |
82d6200 to
e07b201
Compare
There was a problem hiding this comment.
Actionable comments posted: 2
🤖 Fix all issues with AI agents
In `@charts/regions/README.md`:
- Line 87: Document the breaking default change for
operator.operator-crds.create in the README Migration section: add a Version
3.7.0 note explaining that operator.operator-crds.create now defaults to false,
why it changed (CRDs expected to be managed separately or embedded), and clear
upgrade guidance for users from 3.6.9 (set operator.operator-crds.create: true
to preserve old behavior, or install CRDs separately via kubectl apply -f
<crd-manifest-url>, and note that no action is needed if CRDs are already
installed); place this text near the existing Migration section (around the top
~25 lines) so users see it during upgrades.
- Line 67: Add user-facing descriptions for the new Helm chart configuration
keys so the README table explains their purpose: update the table entries for
global.serviceHost, fullnameOverride, nameOverride, settings, and stacks to
include concise descriptions (e.g., what each key controls, expected value
types, defaults and examples) and ensure the text matches the chart's behavior
(values.yaml/templating for these keys such as fullnameOverride and nameOverride
and how settings/stacks are applied). Locate the entries by the exact key names
(global.serviceHost, fullnameOverride, nameOverride, settings, stacks) and
replace the empty description column with brief, accurate descriptions and
example usage.
🧹 Nitpick comments (1)
charts/regions/README.md (1)
11-11: Document the new core dependency.The core chart dependency (version 1.X) was added without explanation. Users need to understand what this dependency provides and why it's required for the Regions chart.
📝 Suggested documentation improvement
Consider adding a section after the Requirements table that explains the purpose of the core dependency:
## Requirements | Repository | Name | Version | |------------|------|---------| | file://../agent | agent | 2.X | | file://../core | core | 1.X | | oci://ghcr.io/formancehq/helm | operator | 3.X | ### Dependency Notes - **core**: Provides shared library chart with common templates and helpers used across Formance charts - **agent**: Formance Membership Agent for region management - **operator**: Formance Kubernetes operator for stack lifecycle management
No description provided.