Remove the SDK version checks from the API sample tests
Maintainers usually reply within 2 days
Nobody has claimed this yet.
Assessment
- Difficulty
- 2/5
- Estimated time
- 1-3 hours
- Newbie friendliness
- 78/100
- Issue type
- Refactor
- Clarity
- Clearly specified
- Activity status
- Active
- Tech stack
- go, java, javascript, node.js, python
- Domain
- documentation, testing
Research direction
Read docs-site/scripts/api-code-samples.integration.test.mjs and docs-site/scripts/api-sdk-support.mjs, then check how the sample tests install and exercise each SDK. Remove the two version equality checks and update the install commands in install-sdk.mdx to use unpinned versions where supported. Done when the tests still run the Node.js samples and the installation instructions no longer require matching audited SDK pins.
Written by the indexing model from the issue text.
Description
Two tests in docs-site/scripts/api-code-samples.integration.test.mjs tie the docs to the SDK versions pinned in sdkVersions in docs-site/scripts/api-sdk-support.mjs:
installed Node SDK matches the exact audited versionrequires the installed@openfga/sdkto equal the pinned js-sdk version.package.jsonuses a caret range, so any PR that refreshes the lockfile after a js-sdk release installs the new version and fails, even when it doesn't touch the SDK or the samples. Once one of those PRs merges, every PR fails until the pin is bumped.mainis in that state now: the lockfile has 0.9.8 and the pin is 0.9.7.native installation instructions name the audited SDK versionsrequiresinstall-sdk.mdxto install exactly the pinned versions, so the page lags every release. All five are behind right now: js 0.9.7 (latest 0.9.8), go 0.8.2 (0.8.4), dotnet 0.10.4 (0.10.5), python 0.10.4 (0.10.6), java 0.10.0 (0.11.2).
Neither check catches a broken sample. The same file already runs every Node.js sample against the installed SDK.
Runs that failed on the first check since the js-sdk 0.9.8 release:
- #1430: https://github.com/openfga/openfga.dev/actions/runs/43927928073/job/133512265810
- #1431: https://github.com/openfga/openfga.dev/actions/runs/44015890450/job/133813606819, https://github.com/openfga/openfga.dev/actions/runs/44471416104/job/135381549020
- #1432: https://github.com/openfga/openfga.dev/actions/runs/44046725101/job/133914129001, https://github.com/openfga/openfga.dev/actions/runs/44333511620/job/134903875984, https://github.com/openfga/openfga.dev/actions/runs/44460188913/job/135344802161
- #1433: https://github.com/openfga/openfga.dev/actions/runs/44284927016/job/134735016518
- #1434: https://github.com/openfga/openfga.dev/actions/runs/44355373777/job/134981942523
Proposal: remove both checks, and use unpinned install commands where the package manager allows it (npm, yarn, go get, dotnet add package, pip).
- Dominant language
- MDX
- Stars
- 52
- Forks
- 110
- Avg merge
- 2d 12h
- Merged PRs (30d)
- 21
Getting set up
- No Dockerfile or Docker Compose file
- No pull request template
- Read the contributing guide
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
More from openfga/openfga.dev
-
Conditions page: mention that conditions don't reduce what Check readsPossibly taken @NopeCharon claimed this 10 days ago. Open
Difficulty 1/5 Under an hour Newbie friendliness 78/100
openfga/openfga.dev#1415 ·
Maintainers usually reply within 2 days
-
No Docker Compose Example for preshared key authentication configurationPossibly taken @NopeCharon claimed this 10 days ago. Open
Difficulty 1/5 1-3 hours Newbie friendliness 72/100
openfga/openfga.dev#788 · 1 reaction ·
Maintainers usually reply within 2 days
-
documentation
Difficulty 3/5 1-2 days Newbie friendliness 45/100
openfga/openfga.dev#964 · 1 comment ·
Maintainers usually reply within 2 days
-
documentation
Difficulty 2/5 1-3 hours Newbie friendliness 58/100
openfga/openfga.dev#963 ·
Maintainers usually reply within 2 days
-
Difficulty 2/5 1-3 hours Newbie friendliness 58/100
openfga/openfga.dev#946 · 2 comments ·
Maintainers usually reply within 2 days
All issues in openfga/openfga.dev
Similar issues
-
Difficulty 2/5 1-3 hours Newbie friendliness 65/100
Maintainers usually reply within 1 day
-
Difficulty 2/5 1-3 hours Newbie friendliness 82/100
solidjs/solid-docs#1716 ·
Maintainers usually reply within 1 day
-
documentation
Difficulty 1/5 Under an hour Newbie friendliness 86/100
Awesome-Embedded-Learning-Studio/Tutorial_AwesomeModernCPP#335 ·
Maintainers usually reply within 1 day
-
Difficulty 1/5 Under an hour Newbie friendliness 75/100
-
Difficulty 1/5 1-3 hours Newbie friendliness 84/100