-
Notifications
You must be signed in to change notification settings - Fork 1
[LFXV2-594] fix ruleset.yaml with openfga disabled #10
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
[LFXV2-594] fix ruleset.yaml with openfga disabled #10
Conversation
…pdated comments to use block syntax for clarity, indicating that allowing all requests is intended for local development only. Jira Ticket: https://linuxfoundation.atlassian.net/browse/LFXV2-594 Generated with [Cursor](https://cursor.com/) Signed-off-by: Mauricio Zanetti Salomao <[email protected]>
WalkthroughConverted two inline comments to Helm/Go-template block comments in ruleset.yaml; logic and conditionals remain unchanged. Changes
Estimated code review effort🎯 1 (Trivial) | ⏱️ ~2 minutes Pre-merge checks and finishing touches✅ Passed checks (5 passed)
✨ Finishing touches🧪 Generate unit tests
Comment |
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.
Pull Request Overview
This pull request updates the ruleset.yaml template in the mailing list service Helm chart to convert regular YAML comments about OpenFGA being disabled into Helm template comments for better compatibility and cleaner rendered output.
- Converts YAML comments (
#) to Helm template comments ({{/* */}}) for OpenFGA disabled scenarios - Ensures comments don't appear in the final rendered YAML when the template is processed
- Maintains the same explanatory content about local development usage
Tip: Customize your code reviews with copilot-instructions.md. Create the file or learn how to get started.
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/lfx-v2-mailing-list-service/templates/ruleset.yaml (1)
33-36: Use Helm block comments with whitespace trimming
- Convert inline comments to
{{- /* … */ -}}to strip surrounding blank lines in the rendered YAML.- Manually run the equivalent
helm templatecommands for both--set openfga.enabled=falseand--set openfga.enabled=trueto verify no stray comments or blank lines appear.
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
Disabled knowledge base sources:
- Jira integration is disabled by default for public repositories
You can enable these sources in your CodeRabbit configuration.
📒 Files selected for processing (1)
charts/lfx-v2-mailing-list-service/templates/ruleset.yaml(2 hunks)
🧰 Additional context used
🧠 Learnings (2)
📚 Learning: 2025-09-02T15:52:00.460Z
Learnt from: prabodhcs
PR: linuxfoundation/lfx-v2-mailing-list-service#6
File: charts/lfx-v2-mailing-list-service/templates/ruleset.yaml:118-137
Timestamp: 2025-09-02T15:52:00.460Z
Learning: User prabodhcs confirmed that using "authorizer: allow_all" in the OpenFGA-enabled branch for the groupsio-mailing-list:create rule in charts/lfx-v2-mailing-list-service/templates/ruleset.yaml is acceptable, despite it bypassing permission checks when OpenFGA is enabled.
Applied to files:
charts/lfx-v2-mailing-list-service/templates/ruleset.yaml
📚 Learning: 2025-09-01T19:57:35.490Z
Learnt from: mauriciozanettisalomao
PR: linuxfoundation/lfx-v2-mailing-list-service#5
File: charts/lfx-v2-mailing-list-service/templates/ruleset.yaml:25-31
Timestamp: 2025-09-01T19:57:35.490Z
Learning: In Heimdall rulesets, when using direct field access like `.Request.Body.project_uid` in templates, it's safe to do so when preceded by a `json_content_type` authorizer that validates the JSON body format first, as the authorizers execute sequentially and the body access only occurs after successful validation.
Applied to files:
charts/lfx-v2-mailing-list-service/templates/ruleset.yaml
⏰ Context from checks skipped due to timeout of 90000ms. You can increase the timeout in your CodeRabbit configuration to a maximum of 15 minutes (900000ms). (1)
- GitHub Check: MegaLinter
🔇 Additional comments (1)
charts/lfx-v2-mailing-list-service/templates/ruleset.yaml (1)
115-118: Repeatable, safe pattern; consider consistency and whitespace trimming.Apply the same Helm comment trimming (
{{- /* ... */ -}}) to other OpenFGA-disabled branches or remove redundant comments for uniformity.
Overview
This pull request makes a minor update to the
ruleset.yamltemplate for the mailing list service Helm chart. The main change is converting comments about OpenFGA being disabled from regular YAML comments to Helm template comments for better compatibility and clarity in the rendered output.Tests