Skip to content

fix: Socket Badge link in README_custom_badges.mustache#680

Merged
SoulPancake merged 1 commit intoopenfga:mainfrom
manuel-lang:patch-1
Feb 22, 2026
Merged

fix: Socket Badge link in README_custom_badges.mustache#680
SoulPancake merged 1 commit intoopenfga:mainfrom
manuel-lang:patch-1

Conversation

@manuel-lang
Copy link
Copy Markdown
Contributor

@manuel-lang manuel-lang commented Feb 21, 2026

Description

The Socket Badge isn't displayed correctly in the README because of a missing parenthesis. This PR aims to fix it.

References

Corresponding PR in the python-sdk repo: !257

Review Checklist

  • I have clicked on "allow edits by maintainers".
  • I have added documentation for new/changed functionality in this PR or in a PR to openfga.dev [Provide a link to any relevant PRs in the references section above]
  • The correct base branch is being used, if not main
  • I have added tests to validate that the change in functionality is working as expected

Summary by CodeRabbit

Release Notes

  • Documentation
    • Updated Socket Badge in Python package documentation to reference version-specific information for improved dependency visibility.

@manuel-lang manuel-lang requested a review from a team as a code owner February 21, 2026 11:13
Copilot AI review requested due to automatic review settings February 21, 2026 11:13
@coderabbitai
Copy link
Copy Markdown
Contributor

coderabbitai bot commented Feb 21, 2026

Walkthrough

Updated the Socket Badge URL in the Python README template to use a version-specific page instead of a general package page. This single-line change makes the badge link more precisely point to version-specific badge information.

Changes

Cohort / File(s) Summary
Python README Template Badge Update
config/clients/python/template/README_custom_badges.mustache
Modified Socket Badge URL to reference a version-specific badge page instead of a general package page.

Estimated code review effort

🎯 1 (Trivial) | ⏱️ ~2 minutes

🚥 Pre-merge checks | ✅ 3
✅ Passed checks (3 passed)
Check name Status Explanation
Description Check ✅ Passed Check skipped - CodeRabbit’s high-level summary is enabled.
Title check ✅ Passed The title clearly and specifically identifies the main change: fixing the Socket Badge link in the README_custom_badges.mustache file, which aligns with the changeset that updates the Socket Badge line.
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.

✏️ Tip: You can configure your own custom pre-merge checks in the settings.

✨ Finishing Touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Post copyable unit tests in a comment

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.

❤️ Share

Comment @coderabbitai help to get the list of available commands and usage tips.

Copy link
Copy Markdown
Contributor

Copilot AI left a 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 fixes a syntax error in the Python SDK template where the Socket Badge markdown link was missing a closing parenthesis. The fix ensures the badge will render correctly in the generated Python SDK README file.

Changes:

  • Fixed missing closing parenthesis in Socket Badge markdown link syntax

Copy link
Copy Markdown
Contributor

@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.

🧹 Nitpick comments (2)
config/clients/python/template/README_custom_badges.mustache (2)

2-2: Optional: make the badge click-through URL version-specific as well.

The image URL includes {{packageVersion}} (version-scoped badge), but the link target is the generic package page. If socket.dev supports version-specific pages at the same path pattern, the link could mirror the image URL for a consistent user experience.

♻️ Suggested change
-[![Socket Badge](https://badge.socket.dev/pypi/package/openfga-sdk/{{packageVersion}})](https://socket.dev/pypi/package/openfga-sdk)
+[![Socket Badge](https://badge.socket.dev/pypi/package/openfga-sdk/{{packageVersion}})](https://socket.dev/pypi/package/openfga-sdk/{{packageVersion}})
🤖 Prompt for AI Agents
Verify each finding against the current code and only fix it if needed.

In `@config/clients/python/template/README_custom_badges.mustache` at line 2,
Update the badge link to be version-specific to match the image URL: change the
anchor href that currently points to the generic package page to use the same
version-scoped path as the image URL by including {{packageVersion}} (the same
token used in the image URL in the README_custom_badges.mustache template) so
the clickable badge navigates to the specific version page on socket.dev.

2-2: Nitpick: use {{packageName}} instead of hardcoded openfga-sdk.

Line 1 uses {{packageName}} for the PyPI badge; both socket.dev URLs on line 2 hardcode openfga-sdk. Using the template variable keeps the file consistent and avoids a silent mismatch if the package name ever changes.

♻️ Suggested change
-[![Socket Badge](https://badge.socket.dev/pypi/package/openfga-sdk/{{packageVersion}})](https://socket.dev/pypi/package/openfga-sdk)
+[![Socket Badge](https://badge.socket.dev/pypi/package/{{packageName}}/{{packageVersion}})](https://socket.dev/pypi/package/{{packageName}})
🤖 Prompt for AI Agents
Verify each finding against the current code and only fix it if needed.

In `@config/clients/python/template/README_custom_badges.mustache` at line 2, The
socket.dev badge lines in README_custom_badges.mustache hardcode "openfga-sdk";
update both occurrences (the image URL and the link URL) to use the template
variable {{packageName}} instead so they match the existing {{packageName}}
usage for PyPI and avoid future mismatches.
🤖 Prompt for all review comments with AI agents
Verify each finding against the current code and only fix it if needed.

Nitpick comments:
In `@config/clients/python/template/README_custom_badges.mustache`:
- Line 2: Update the badge link to be version-specific to match the image URL:
change the anchor href that currently points to the generic package page to use
the same version-scoped path as the image URL by including {{packageVersion}}
(the same token used in the image URL in the README_custom_badges.mustache
template) so the clickable badge navigates to the specific version page on
socket.dev.
- Line 2: The socket.dev badge lines in README_custom_badges.mustache hardcode
"openfga-sdk"; update both occurrences (the image URL and the link URL) to use
the template variable {{packageName}} instead so they match the existing
{{packageName}} usage for PyPI and avoid future mismatches.

Copy link
Copy Markdown
Member

@SoulPancake SoulPancake left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks <3

@SoulPancake SoulPancake added this pull request to the merge queue Feb 22, 2026
Merged via the queue into openfga:main with commit 7dc899c Feb 22, 2026
16 of 19 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants