-
Notifications
You must be signed in to change notification settings - Fork 4
fix(console): move object values #116
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Conversation
WalkthroughThis pull request updates version numbers in several Helm chart README files. The Cloudprem chart’s version is incremented from 3.0.0-rc.15 to 3.0.0-rc.16 while the Console and Portal charts are bumped from 2.1.2 to 2.1.3. In addition, configuration parameters for cookies and OAuth clients have been reorganized and renamed in the Cloudprem, Console, and Portal templates to clearly distinguish between environments. Changes
Sequence Diagram(s)Possibly related PRs
Suggested reviewers
Poem
📜 Recent review detailsConfiguration used: CodeRabbit UI ⛔ Files ignored due to path filters (8)
📒 Files selected for processing (8)
🚧 Files skipped from review as they are similar to previous changes (7)
🧰 Additional context used🪛 LanguageToolREADME.md[style] ~13-~13: Using many exclamation marks might seem excessive (in this case: 10 exclamation marks for a text that’s 3032 characters long) (EN_EXCESSIVE_EXCLAMATION) ⏰ Context from checks skipped due to timeout of 90000ms (1)
🔇 Additional comments (3)
Thank you for using CodeRabbit. We offer it for free to the OSS community and would appreciate your support in helping us grow. If you find it useful, would you consider giving us a shout-out on your favorite social media? 🪧 TipsChatThere are 3 ways to chat with CodeRabbit:
Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments. CodeRabbit Commands (Invoked using PR comments)
Other keywords and placeholders
CodeRabbit Configuration File (
|
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Actionable comments posted: 0
🧹 Nitpick comments (1)
charts/portal/README.md (1)
48-50: New Cookie Configuration Keys Added
These lines add new global configuration keys for cookie management under the console namespace, which affects authentication between console-v2 and portal. It is recommended to adjust the description for clarity: for example, changing
"is used to encrypt a cookie that store authentication between console-v2 and portal"
to
"is used to encrypt a cookie that stores authentication details between console-v2 and portal"
for improved grammar and clarity. Also, please ensure that these key names and their descriptions are consistent with documentation in other charts.
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
⛔ Files ignored due to path filters (6)
charts/cloudprem/Chart.lockis excluded by!**/*.lock,!**/*.lockcharts/cloudprem/Chart.yamlis excluded by!**/*.yamlcharts/console/Chart.yamlis excluded by!**/*.yamlcharts/portal/Chart.yamlis excluded by!**/*.yamlcharts/portal/values.schema.jsonis excluded by!**/*.jsoncharts/portal/values.yamlis excluded by!**/*.yaml
📒 Files selected for processing (7)
README.md(1 hunks)charts/cloudprem/README.md(3 hunks)charts/cloudprem/README.md.gotmpl(1 hunks)charts/console/README.md(1 hunks)charts/console/templates/_helpers.tpl(1 hunks)charts/portal/README.md(2 hunks)charts/portal/templates/_helpers.tpl(1 hunks)
✅ Files skipped from review due to trivial changes (2)
- charts/console/README.md
- charts/cloudprem/README.md
🧰 Additional context used
🪛 LanguageTool
README.md
[style] ~13-~13: Using many exclamation marks might seem excessive (in this case: 10 exclamation marks for a text that’s 3032 characters long)
Context: ...tions, users, roles, and permissions. | | | Portal | 2.1.3 | 5e7b404a3a208b1f38603719e02a8b1883c10acf | Formance Portal |
| | Regions | 2.11.5 | latest | Formance Private Regions Helm Chart |
| | Stargate | 0.7.3 | latest | Formance EE Stargate gRPC Gateway | [
🔇 Additional comments (8)
charts/cloudprem/README.md.gotmpl (2)
300-308: Doc changes appear consistent with the overall restructuring.These lines accurately describe how cookie and OAuth configs are shifting from portal-level settings toward console-specific settings. This documentation is aligned with the updated references in the code, helping users migrate and configure them properly.
310-313: Good clarity on newly added parameters.The additions for
global.platform.consoleV3.oauth.clientandconsole-v3.config.cookieprovide clear guidance on configuring the new console-v3 features. Thanks for explicitly documenting these new fields.charts/console/templates/_helpers.tpl (1)
60-67: Console cookie configuration looks correct.Setting
ENCRYPTION_KEYfrom.Values.global.platform.console.cookieor falling back to.Values.config.encryption_keymatches the documented approach. Ensure all references to the old portal-based setting are removed to avoid confusion.charts/portal/templates/_helpers.tpl (1)
47-54: Properly separating cookie secrets for console and portal.Using
CONSOLE_COOKIE_SECRETfor console cookies under.Values.global.platform.console.cookieclarifies the boundary between console and portal session management. This aligns with the broader refactor of cookie handling across the codebase.charts/portal/README.md (1)
3-3: Version Badge Updated Successfully!
The version badge is now updated to 2.1.3, which confirms the intended release version. Please verify that this update is reflected consistently across related documentation.README.md (3)
8-8: Cloudprem Chart Version Update
The Cloudprem chart version has been correctly bumped from3.0.0-rc.15to 3.0.0-rc.16. Ensure that this update is consistent with any downstream documentation and configuration references.
9-9: Console Chart Version Update
The Console chart version update to 2.1.3 looks accurate. Please double-check that all related documentation now points to version 2.1.3.
14-14: Portal Chart Version Update
The Portal chart version update to 2.1.3 is correctly applied here. Confirm that this version change is reflected in any other dependent files or references.
0423f49 to
e3254fd
Compare
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Actionable comments posted: 0
🧹 Nitpick comments (2)
charts/cloudprem/README.md.gotmpl (2)
300-307: LGTM! Well-documented breaking changes.The breaking changes are clearly documented with a detailed mapping of old to new configuration parameters.
Consider adding example snippets showing the before and after configuration to make the migration path clearer for users.
311-312: Enhance documentation for new configuration parameters.While the new parameters are listed, consider adding:
- Example values
- Default values
- Use cases for when these parameters should be configured
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
⛔ Files ignored due to path filters (8)
charts/cloudprem/Chart.lockis excluded by!**/*.lock,!**/*.lockcharts/cloudprem/Chart.yamlis excluded by!**/*.yamlcharts/console/Chart.yamlis excluded by!**/*.yamlcharts/console/values.schema.jsonis excluded by!**/*.jsoncharts/console/values.yamlis excluded by!**/*.yamlcharts/portal/Chart.yamlis excluded by!**/*.yamlcharts/portal/values.schema.jsonis excluded by!**/*.jsoncharts/portal/values.yamlis excluded by!**/*.yaml
📒 Files selected for processing (7)
README.md(1 hunks)charts/cloudprem/README.md(3 hunks)charts/cloudprem/README.md.gotmpl(1 hunks)charts/console/README.md(2 hunks)charts/console/templates/_helpers.tpl(1 hunks)charts/portal/README.md(2 hunks)charts/portal/templates/_helpers.tpl(1 hunks)
🚧 Files skipped from review as they are similar to previous changes (5)
- charts/portal/templates/_helpers.tpl
- charts/portal/README.md
- charts/console/README.md
- charts/console/templates/_helpers.tpl
- charts/cloudprem/README.md
🧰 Additional context used
🪛 LanguageTool
README.md
[style] ~13-~13: Using many exclamation marks might seem excessive (in this case: 10 exclamation marks for a text that’s 3032 characters long)
Context: ...tions, users, roles, and permissions. | | | Portal | 2.1.3 | 5e7b404a3a208b1f38603719e02a8b1883c10acf | Formance Portal |
| | Regions | 2.11.5 | latest | Formance Private Regions Helm Chart |
| | Stargate | 0.7.3 | latest | Formance EE Stargate gRPC Gateway | [
⏰ Context from checks skipped due to timeout of 90000ms (1)
- GitHub Check: Tests
🔇 Additional comments (1)
README.md (1)
8-9: LGTM! Version updates are consistent.The version increments align with the breaking changes and new features documented in the Cloudprem README:
- Cloudprem: 3.0.0-rc.16 (OAuth clients and cookies reorganization)
- Console: 2.1.3 (Cookie management updates)
- Portal: 2.1.3 (Cookie management updates)
Also applies to: 14-14
1f83cf1 to
2a1a859
Compare
No description provided.