-
Notifications
You must be signed in to change notification settings - Fork 16
fix: update test command in README for FGA #68
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
|
Important Review skippedAuto incremental reviews are disabled on this repository. Please check the settings in the CodeRabbit UI or the You can disable this status message by setting the WalkthroughUpdated documentation in stores/abac-with-rebac/README.md to reference store.fga.yaml instead of store.yaml in both an instruction line and an example block. No code or API changes. Changes
Estimated code review effort🎯 1 (Trivial) | ⏱️ ~2 minutes Suggested reviewers
Pre-merge checks and finishing touches✅ Passed checks (3 passed)
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. 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.
Actionable comments posted: 0
🧹 Nitpick comments (1)
stores/abac-with-rebac/README.md (1)
64-64: Use ./store.fga.yaml and normalize README test commands repo-wideChange is correct — prefer
./store.fga.yamlfor clarity. Repo search shows many README files still callfga model test --tests store.yaml; update those tofga model test --tests ./store.fga.yaml.-2. In the `abac-with-rebac` directory, run `fga model test --tests store.fga.yaml` +2. In the `abac-with-rebac` directory, run `fga model test --tests ./store.fga.yaml`Examples of affected files: stores/slack/README.md:118, stores/superadmin/README.md:26, stores/role-assignments/README.md:78, stores/iot/README.md:83, stores/expenses/README.md:79, stores/github/README.md:106, stores/developer-portal/README.md:27, stores/gdrive/README.md:120, stores/custom-roles/README.md:113, stores/entitlements/README.md:106.
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
📒 Files selected for processing (1)
stores/abac-with-rebac/README.md(1 hunks)
🧰 Additional context used
🧠 Learnings (2)
📚 Learning: 2025-08-07T12:33:08.458Z
Learnt from: CR
PR: openfga/sample-stores#0
File: .github/copilot-instructions.md:0-0
Timestamp: 2025-08-07T12:33:08.458Z
Learning: Applies to **/*.fga.yaml : Use the .fga.yaml file format to define and test OpenFGA authorization models, including model, tuples, and tests sections
Applied to files:
stores/abac-with-rebac/README.md
📚 Learning: 2025-08-07T12:33:08.458Z
Learnt from: CR
PR: openfga/sample-stores#0
File: .github/copilot-instructions.md:0-0
Timestamp: 2025-08-07T12:33:08.458Z
Learning: Applies to **/*.fga.yaml : Define test cases for OpenFGA models in the tests section of .fga.yaml files, including check, list_objects, and list_users tests
Applied to files:
stores/abac-with-rebac/README.md
⏰ 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: Socket Security: Pull Request Alerts
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 PR corrects a documentation error in the README file for the abac-with-rebac store example. The test command previously referenced an incorrect filename (store.yaml) and now correctly references store.fga.yaml, which is the actual configuration file present in the directory.
Key Changes
- Updated the FGA CLI test command to use the correct filename
store.fga.yamlinstead ofstore.yaml
Description
What problem is being solved?
How is it being solved?
What changes are made to solve it?
References
Review Checklist
mainSummary by CodeRabbit