Skip to content

Conversation

@Dav-14
Copy link
Contributor

@Dav-14 Dav-14 commented Feb 20, 2025

No description provided.

@Dav-14 Dav-14 requested a review from a team as a code owner February 20, 2025 11:19
@coderabbitai
Copy link

coderabbitai bot commented Feb 20, 2025

Walkthrough

This 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

File(s) Change Summary
README.md, charts/cloudprem/README.md, charts/console/README.md, charts/portal/README.md Updated Helm chart version numbers and corresponding version badges (Cloudprem: 3.0.0-rc.16; Console & Portal: 2.1.3).
charts/cloudprem/README.md.gotmpl, charts/console/templates/_helpers.tpl, charts/portal/templates/_helpers.tpl Reorganized configuration parameters: moved, renamed, and removed cookie and OAuth settings to align console and portal configurations.
test/helm/suite/console_test.go Updated test cases to reflect new cookie-related keys for the console, replacing references from portal to console.

Sequence Diagram(s)

Possibly related PRs

Suggested reviewers

  • flemzord

Poem

I'm a little rabbit, hopping with glee,
Versions updated, as clear as can be,
Cookies and keys get a fresh new name,
In charts and templates, nothing's the same,
With each little change, I dance with delight —
CodeRabbit's hops make the future bright!
🐰✨


📜 Recent review details

Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between 1f83cf1 and 2a1a859.

⛔ Files ignored due to path filters (8)
  • charts/cloudprem/Chart.lock is excluded by !**/*.lock, !**/*.lock
  • charts/cloudprem/Chart.yaml is excluded by !**/*.yaml
  • charts/console/Chart.yaml is excluded by !**/*.yaml
  • charts/console/values.schema.json is excluded by !**/*.json
  • charts/console/values.yaml is excluded by !**/*.yaml
  • charts/portal/Chart.yaml is excluded by !**/*.yaml
  • charts/portal/values.schema.json is excluded by !**/*.json
  • charts/portal/values.yaml is excluded by !**/*.yaml
📒 Files selected for processing (8)
  • 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)
  • test/helm/suite/console_test.go (3 hunks)
🚧 Files skipped from review as they are similar to previous changes (7)
  • charts/portal/README.md
  • charts/console/README.md
  • charts/cloudprem/README.md
  • charts/console/templates/_helpers.tpl
  • test/helm/suite/console_test.go
  • charts/portal/templates/_helpers.tpl
  • charts/cloudprem/README.md.gotmpl
🧰 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. | Artifact HUB | | Portal | 2.1.3 | 5e7b404a3a208b1f38603719e02a8b1883c10acf | Formance Portal | Artifact HUB | | Regions | 2.12.0 | latest | Formance Private Regions Helm Chart | Artifact HUB | | Stargate | 0.7.3 | latest | Formance EE Stargate gRPC Gateway | [![Artifact HUB](https://img.shields.io/en...

(EN_EXCESSIVE_EXCLAMATION)

⏰ Context from checks skipped due to timeout of 90000ms (1)
  • GitHub Check: Tests
🔇 Additional comments (3)
README.md (3)

8-8: Cloudprem Chart Version Update Verified
The Cloudprem chart version has been correctly updated from 3.0.0-rc.15 to 3.0.0-rc.16. Please ensure that any related documentation or configuration files (e.g., charts/cloudprem/README.md) are in sync with this change.


9-9: Console Chart Version Update & Object Values Note
The Console chart version is updated to 2.1.3, which appears correct. Note that the PR title mentions "move object values" for the console; if this change affects any object key locations or configurations, please confirm that the README or corresponding chart files reflect those modifications.


14-14: Portal Chart Version Update Verified
The Portal chart version update to 2.1.3 is correct. Ensure any modifications regarding cookie configurations or object values (if applicable) are consistently documented across related charts.


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?

❤️ Share
🪧 Tips

Chat

There are 3 ways to chat with CodeRabbit:

  • Review comments: Directly reply to a review comment made by CodeRabbit. Example:
    • I pushed a fix in commit <commit_id>, please review it.
    • Generate unit testing code for this file.
    • Open a follow-up GitHub issue for this discussion.
  • Files and specific lines of code (under the "Files changed" tab): Tag @coderabbitai in a new review comment at the desired location with your query. Examples:
    • @coderabbitai generate unit testing code for this file.
    • @coderabbitai modularize this function.
  • PR comments: Tag @coderabbitai in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples:
    • @coderabbitai gather interesting stats about this repository and render them as a table. Additionally, render a pie chart showing the language distribution in the codebase.
    • @coderabbitai read src/utils.ts and generate unit testing code.
    • @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.
    • @coderabbitai help me debug CodeRabbit configuration file.

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)

  • @coderabbitai pause to pause the reviews on a PR.
  • @coderabbitai resume to resume the paused reviews.
  • @coderabbitai review to trigger an incremental review. This is useful when automatic reviews are disabled for the repository.
  • @coderabbitai full review to do a full review from scratch and review all the files again.
  • @coderabbitai summary to regenerate the summary of the PR.
  • @coderabbitai generate docstrings to generate docstrings for this PR. (Beta)
  • @coderabbitai resolve resolve all the CodeRabbit review comments.
  • @coderabbitai configuration to show the current CodeRabbit configuration for the repository.
  • @coderabbitai help to get help.

Other keywords and placeholders

  • Add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.
  • Add @coderabbitai summary to generate the high-level summary at a specific location in the PR description.
  • Add @coderabbitai anywhere in the PR title to generate the title automatically.

CodeRabbit Configuration File (.coderabbit.yaml)

  • You can programmatically configure CodeRabbit by adding a .coderabbit.yaml file to the root of your repository.
  • Please see the configuration documentation for more information.
  • If your editor has YAML language server enabled, you can add the path at the top of this file to enable auto-completion and validation: # yaml-language-server: $schema=https://coderabbit.ai/integrations/schema.v2.json

Documentation and Community

  • Visit our Documentation for detailed information on how to use CodeRabbit.
  • Join our Discord Community to get help, request features, and share feedback.
  • Follow us on X/Twitter for updates and announcements.

@github-actions github-actions bot added bug Something isn't working docs feature release labels Feb 20, 2025
Copy link

@coderabbitai coderabbitai bot left a 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

📥 Commits

Reviewing files that changed from the base of the PR and between fdfd3bd and 0423f49.

⛔ Files ignored due to path filters (6)
  • charts/cloudprem/Chart.lock is excluded by !**/*.lock, !**/*.lock
  • charts/cloudprem/Chart.yaml is excluded by !**/*.yaml
  • charts/console/Chart.yaml is excluded by !**/*.yaml
  • charts/portal/Chart.yaml is excluded by !**/*.yaml
  • charts/portal/values.schema.json is excluded by !**/*.json
  • charts/portal/values.yaml is 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. | Artifact HUB | | Portal | 2.1.3 | 5e7b404a3a208b1f38603719e02a8b1883c10acf | Formance Portal | Artifact HUB | | Regions | 2.11.5 | latest | Formance Private Regions Helm Chart | Artifact HUB | | Stargate | 0.7.3 | latest | Formance EE Stargate gRPC Gateway | [![Artifact HUB](https://img.shields.io/en...

(EN_EXCESSIVE_EXCLAMATION)

🔇 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.client and console-v3.config.cookie provide 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_KEY from .Values.global.platform.console.cookie or falling back to .Values.config.encryption_key matches 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_SECRET for console cookies under .Values.global.platform.console.cookie clarifies 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 from 3.0.0-rc.15 to 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.

@Dav-14 Dav-14 force-pushed the feat/pla-233-fixcloudprem-console-v2 branch from 0423f49 to e3254fd Compare February 20, 2025 11:54
Copy link

@coderabbitai coderabbitai bot left a 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

📥 Commits

Reviewing files that changed from the base of the PR and between 0423f49 and e3254fd.

⛔ Files ignored due to path filters (8)
  • charts/cloudprem/Chart.lock is excluded by !**/*.lock, !**/*.lock
  • charts/cloudprem/Chart.yaml is excluded by !**/*.yaml
  • charts/console/Chart.yaml is excluded by !**/*.yaml
  • charts/console/values.schema.json is excluded by !**/*.json
  • charts/console/values.yaml is excluded by !**/*.yaml
  • charts/portal/Chart.yaml is excluded by !**/*.yaml
  • charts/portal/values.schema.json is excluded by !**/*.json
  • charts/portal/values.yaml is 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. | Artifact HUB | | Portal | 2.1.3 | 5e7b404a3a208b1f38603719e02a8b1883c10acf | Formance Portal | Artifact HUB | | Regions | 2.11.5 | latest | Formance Private Regions Helm Chart | Artifact HUB | | Stargate | 0.7.3 | latest | Formance EE Stargate gRPC Gateway | [![Artifact HUB](https://img.shields.io/en...

(EN_EXCESSIVE_EXCLAMATION)

⏰ 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

@Dav-14 Dav-14 force-pushed the feat/pla-233-fixcloudprem-console-v2 branch from 1f83cf1 to 2a1a859 Compare February 24, 2025 09:32
@Dav-14 Dav-14 enabled auto-merge February 24, 2025 09:35
@Dav-14 Dav-14 disabled auto-merge February 24, 2025 09:35
@Dav-14 Dav-14 enabled auto-merge February 24, 2025 09:35
@Dav-14 Dav-14 added this pull request to the merge queue Feb 24, 2025
Merged via the queue into main with commit 9e66d1d Feb 24, 2025
5 checks passed
@Dav-14 Dav-14 deleted the feat/pla-233-fixcloudprem-console-v2 branch February 24, 2025 09:42
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

bug Something isn't working docs feature release

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants