Conversation
|
Important Review skippedAuto incremental reviews are disabled on this repository. Please check the settings in the CodeRabbit UI or the ⚙️ Run configurationConfiguration used: Organization UI Review profile: CHILL Plan: Pro Run ID: You can disable this status message by setting the Use the checkbox below for a quick retry:
WalkthroughThe PR introduces automated release infrastructure using release-please. It adds a GitHub Actions workflow configuration, release-please manifests and configuration files, a release process guide, and version tracking markers in version-bearing files. Changes
Estimated code review effort🎯 2 (Simple) | ⏱️ ~10 minutes Suggested reviewers
🚥 Pre-merge checks | ✅ 3✅ Passed checks (3 passed)
✏️ Tip: You can configure your own custom pre-merge checks in the settings. ✨ Finishing Touches🧪 Generate unit tests (beta)
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 |
Codecov Report✅ All modified and coverable lines are covered by tests. Additional details and impacted files@@ Coverage Diff @@
## main #262 +/- ##
=======================================
Coverage 69.84% 69.84%
=======================================
Files 140 140
Lines 10743 10743
=======================================
Hits 7503 7503
Misses 3240 3240 ☔ View full report in Codecov by Sentry. 🚀 New features to boost your workflow:
|
There was a problem hiding this comment.
Pull request overview
Adds release automation via release-please for the Python SDK repo, including configuration, manifest, a GitHub Actions workflow, and operator documentation.
Changes:
- Add
release-please-config.jsonand.release-please-manifest.jsonto drive automated versioning and changelog generation. - Add a
release-pleaseGitHub Actions workflow withworkflow_dispatchinputs. - Add
RELEASE.mdand annotateSDK_VERSIONfor release-please-managed updates.
Reviewed changes
Copilot reviewed 5 out of 5 changed files in this pull request and generated 6 comments.
Show a summary per file
| File | Description |
|---|---|
RELEASE.md |
New release runbook describing how to cut releases and troubleshoot release-please. |
release-please-config.json |
Release-please configuration for Python releases, changelog sections, and extra files to bump. |
openfga_sdk/constants.py |
Marks SDK_VERSION for automated version bumping. |
.release-please-manifest.json |
Initializes the release-please manifest version. |
.github/workflows/release-please.yml |
Adds the workflow that runs the reusable release-please automation. |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
Actionable comments posted: 4
🤖 Prompt for all review comments with AI agents
Verify each finding against the current code and only fix it if needed.
Inline comments:
In @.github/workflows/release-please.yml:
- Line 39: Replace the mutable branch ref in the reusable workflow reference
"openfga/sdk-generator/.github/workflows/release-please.yml@main" with an
immutable commit SHA: locate the line containing that uses string and change the
`@main` suffix to a specific full commit SHA from the openfga/sdk-generator repo
(obtain the SHA from the repo's commit history or GitHub UI) so the workflow is
pinned to an immutable revision for supply-chain integrity.
- Around line 7-9: The push-event commit-message check uses
startsWith(github.event.head_commit.message, 'release:'), which misses
release-please commit titles like "chore(release): ..."; update the condition to
detect any release-related commit (for example replace
startsWith(github.event.head_commit.message, 'release:') with
contains(github.event.head_commit.message, 'release') or use
matches(github.event.head_commit.message, '.*release.*')) so commits such as
"chore(release): v0.10.0 (`#261`)" will correctly trigger the release job.
In `@RELEASE.md`:
- Around line 64-66: The fenced code blocks in the RELEASE.md snippet (the block
containing "0.11.0-beta.1 → explicit: 0.11.0-beta.2 → explicit: 0.11.0" and
the block with the changelog lines "feat: add support for batch check ..." etc.)
are missing language identifiers and trigger MD040; update both fenced blocks to
include a language tag (use "text") so they become "```text" at the opening
fence, preserving the inner content exactly. Ensure every fenced code block in
that area uses the language identifier to satisfy markdownlint.
- Around line 80-82: The RELEASE.md states that the "refactor" type is hidden,
but release-please is configured differently; update either the changelog or the
release-please configuration so they match: locate the "refactor" entry in
release-please-config.json and set "hidden": true to match RELEASE.md, or
alternatively change the RELEASE.md wording to indicate "refactor" is not
hidden; ensure the "refactor" symbol and its "hidden" boolean in
release-please-config.json and the RELEASE.md phrasing are consistent.
🪄 Autofix (Beta)
Fix all unresolved CodeRabbit comments on this PR:
- Push a commit to this branch (recommended)
- Create a new PR with the fixes
ℹ️ Review info
⚙️ Run configuration
Configuration used: Organization UI
Review profile: CHILL
Plan: Pro
Run ID: d4e69b7e-e0f9-4e4c-9db6-051d2dbb8f39
📒 Files selected for processing (8)
.github/workflows/release-please.yml.release-please-manifest.jsonREADME.mdRELEASE.mdexample/example1/requirements.txtexample/example1/setup.pyopenfga_sdk/constants.pyrelease-please-config.json
Description
What problem is being solved?
How is it being solved?
What changes are made to solve it?
References
Review Checklist
mainSummary by CodeRabbit