docs: update OpenFGA configuration for v1.8.16 & CI automation #1054
Conversation
- Update configuration documentation to reference v1.8.15 - Update resolveNodeBreadthLimit default value from 100 to 10 - Update dependencies to latest versions
|
No dependency changes detected. Learn more about Socket for GitHub. 👍 No dependency changes detected in pull request |
|
@Siddhant-K-code the config update script does get run as part of the build process which runs nightly so we do have the latest v1.8.16 config out now which unfortunately makes the contents of this PR outdated, What do you think about reworking this PR to integrate something like stefanzweifel/git-auto-commit-action so that the rebuild in CI is then pushed back to the repo? |
|
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 ## Walkthrough
The changes update OpenFGA configuration documentation to reflect version 1.8.16, adding new datastore and cache options, revising defaults, and reordering configuration sections. Additionally, project dependencies in `package.json` are upgraded, including Docusaurus, OpenFGA SDK, and various TypeScript and linting packages. The GitHub Actions deployment workflow was enhanced with explicit permissions and an auto-commit step for updated documentation. No code or public API changes are present.
## Changes
| File(s) | Change Summary |
|------------------------------------------------|----------------------------------------------------------------------------------------------------|
| docs/content/getting-started/setup-openfga/configuration.mdx | Updated OpenFGA configuration documentation to v1.8.16: added secondary datastore and cache options, changed default values, reordered options, and updated version references. |
| package.json | Upgraded dependencies: Docusaurus (3.7.0→3.8.1), OpenFGA SDK (^0.8.1→^0.9.0), TypeScript, linting, and other packages. |
| .github/workflows/deploy.yml | Added explicit permissions for deployment job and a new step to auto-commit updated Markdown docs after build. |
## Sequence Diagram(s)
*No sequence diagrams generated as the changes are limited to documentation, dependency updates, and CI workflow enhancements.*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. 🪧 TipsChatThere are 3 ways to chat with CodeRabbit:
SupportNeed help? Create a ticket on our support page for assistance with any issues or questions. 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 (
|
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
Actionable comments posted: 1
🧹 Nitpick comments (1)
docs/content/getting-started/setup-openfga/configuration.mdx (1)
202-202: Add description and default forsharedIteratorThe
sharedIteratorrow is missing Type, Description, and Default Value. Please verify whether this option is supported in the schema and populate the table accordingly or remove it if it’s not valid.
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
⛔ Files ignored due to path filters (1)
package-lock.jsonis excluded by!**/package-lock.json
📒 Files selected for processing (2)
docs/content/getting-started/setup-openfga/configuration.mdx(4 hunks)package.json(2 hunks)
⏰ Context from checks skipped due to timeout of 90000ms (5)
- GitHub Check: Socket Security: Pull Request Alerts
- GitHub Check: Test deployment
- GitHub Check: markdown-link-check-md
- GitHub Check: Run Checks
- GitHub Check: markdown-link-check
🔇 Additional comments (6)
docs/content/getting-started/setup-openfga/configuration.mdx (3)
119-119: Correct default forresolveNodeBreadthLimitThe default value is accurately set to
10according to the v1.8.15 schema.
137-141: Document secondary datastore connection parametersThe added entries for
datastore.secondaryUri,datastore.secondaryUsername, anddatastore.secondaryPasswordcorrectly reflect the new secondary‐datastore fields in config-schema v1.8.15.
191-197: ListObjects iterator cache and dispatch throttling optionsThe
listObjectsIteratorCacheand updatedlistObjectsDispatchThrottlingfields match the v1.8.15 schema changes.package.json (3)
28-31: Upgrade core and OpenFGA SDK dependenciesThe
@docusaurus/*packages and@openfga/sdkhave been bumped to their latest versions, aligning the docs site with OpenFGA v1.8.15. The version changes look correct.Also applies to: 34-34
43-44: Bumpsanitize-htmlandswagger-ui-reactUpgrading these packages to newer minor releases improves security and feature support.
47-57: Update devDependencies for TypeScript and ESLintDev dependencies (
@typescript-eslint,eslint,@types/react, etc.) have been updated to match Docusaurus v3.8.1 and modern linting requirements. Please verify that CI lint and type-check tasks pass after these upgrades.
|
@ewanharris, I've updated it in |
Siddhant-K-code
changed the title
There was a problem hiding this comment.
Actionable comments posted: 0
🧹 Nitpick comments (1)
.github/workflows/deploy.yml (1)
41-49: Refine the auto-commit step
- Narrow the file pattern to only target docs (
docs/content/**/*.mdx) to avoid unintended commits.- Add
skip_empty_commit: true(or the correct field name per your action version) to prevent empty commits when no docs have changed.Apply this diff within lines 41–49:
- file_pattern: '*.mdx' + file_pattern: 'docs/content/**/*.mdx' + skip_empty_commit: true
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
📒 Files selected for processing (2)
.github/workflows/deploy.yml(2 hunks)docs/content/getting-started/setup-openfga/configuration.mdx(4 hunks)
🚧 Files skipped from review as they are similar to previous changes (1)
- docs/content/getting-started/setup-openfga/configuration.mdx
⏰ Context from checks skipped due to timeout of 90000ms (3)
- GitHub Check: deploy-preview
- GitHub Check: markdown-link-check-md
- GitHub Check: Test deployment
🔇 Additional comments (1)
.github/workflows/deploy.yml (1)
18-21: Ensure minimal required permissions
Verify whether each scope is strictly necessary. For example, if the auto-commit and Pages deployment steps don’t leverage OIDC, you can drop or reduceid-token: writeto adhere to least-privilege principles.
| "docusaurus-plugin-module-alias": "0.0.2", | ||
| "eslint": "8.57.0", | ||
| "eslint-config-prettier": "10.1.2", | ||
| "eslint": "9.29.0", |
There was a problem hiding this comment.
Looks like there's some migration needed as part of the eslint 9 update as the lint step in CI is now failing, I think we need to migrate the existing .eslintrc.json to eslint.config.js
ESLint: 9.29.0
ESLint couldn't find an eslint.config.(js|mjs|cjs) file.
There was a problem hiding this comment.
@Siddhant-K-code do you think it would be OK to split this PR?
- updating to openfga 1.9.0
- adding the GH Action
- Updating the dependencies
1 and 3 should be easy to approve and merge (keeping in mind @ewanharris's comment re eslint v9), 2 still thinking about it
|
@ewanharris, @rhamzeh sure, i can split these PRs this weekend! |
|
@ewanharris @rhamzeh, I've opened three different PRs to address overall problems: |
4 participants
Description
References
Review Checklist
mainSummary by CodeRabbit
Documentation
Chores
Chores