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:
WalkthroughThis pull request introduces release automation by adding a GitHub Actions workflow that delegates to a reusable release-please workflow, along with configuration files, versioning manifest, and release documentation to automate versioning and changelog generation. Changes
Estimated code review effort🎯 2 (Simple) | ⏱️ ~10 minutes Possibly related PRs
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 |
![github-advanced-security[bot]](https://avatars.githubusercontent.com/in/57789?s=60&v=4){kind=small}
Codecov Report✅ All modified and coverable lines are covered by tests. ❌ Your project status has failed because the head coverage (38.04%) is below the target coverage (80.00%). You can increase the head coverage or adjust the target coverage. Additional details and impacted files@@ Coverage Diff @@
## main #312 +/- ##
============================================
- Coverage 38.05% 38.04% -0.02%
+ Complexity 1259 1258 -1
============================================
Files 198 198
Lines 7646 7646
Branches 885 885
============================================
- Hits 2910 2909 -1
Misses 4598 4598
- Partials 138 139 +1 ☔ View full report in Codecov by Sentry. 🚀 New features to boost your workflow:
|
There was a problem hiding this comment.
Pull request overview
This PR introduces release-please configuration and documentation to automate version bumps, changelog generation, and release PR creation for the OpenFGA Java SDK.
Changes:
- Add release-please manifest/config and a reusable GitHub Actions workflow for releases.
- Annotate version declarations to be discoverable by release-please.
- Document the intended release process and versioning rules in a new release guide.
Reviewed changes
Copilot reviewed 5 out of 6 changed files in this pull request and generated 6 comments.
Show a summary per file
| File | Description |
|---|---|
src/main/java/dev/openfga/sdk/constants/FgaConstants.java |
Adds a release-please version marker to the SDK version constant. |
build.gradle |
Adds a release-please version marker to the Gradle project version. |
release-please-config.json |
Adds release-please configuration (changelog sections, extra-files, pre-1.0 bump behavior). |
.release-please-manifest.json |
Adds the initial release-please manifest version. |
.github/workflows/release-please.yml |
Adds the release-please workflow (push + manual dispatch) using a reusable workflow. |
RELEASE.md |
Adds documentation describing how to cut releases and troubleshoot release-please. |
💡 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: The workflow currently references the reusable workflow with a
floating branch ref
"openfga/sdk-generator/.github/workflows/release-please.yml@main"; change this
to an immutable commit SHA by replacing "@main" with the specific commit hash
from the upstream repo (obtain the current commit SHA for that workflow from the
upstream repo and update the "uses:" entry accordingly) so the workflow always
executes that exact version; ensure you commit the updated
.github/workflows/release-please.yml and, if desired, add a brief comment noting
the upstream SHA and provenance for future updates to the reusable workflow.
In `@release-please-config.json`:
- Around line 22-25: The release-please config is missing publish.gradle in
"extra-files", so publish.gradle's hardcoded version (e.g., the value at line 9)
won't be updated on version bumps; update the release-please JSON by adding an
entry for publish.gradle to the "extra-files" array (same format as the existing
entries referencing build.gradle and
src/main/java/dev/openfga/sdk/constants/FgaConstants.java) so release-please
will rewrite the version in publish.gradle and keep POM metadata and artifact
versioning in sync.
In `@RELEASE.md`:
- Around line 75-82: The RELEASE.md changelog mapping shows the "refactor" type
as "(hidden)" which conflicts with the actual release-please configuration;
update the mapping in RELEASE.md to match release-please-config.json (where
"refactor" is mapped to "Changed" / visible) so the documentation and config
agree—locate the changelog mapping block in RELEASE.md and change the "refactor:
extract auth helper" line to reflect the visible mapping used by
release-please-config.json.
- Around line 64-66: The fenced code blocks in RELEASE.md are missing language
identifiers (markdownlint MD040); update each ``` fence for the version line
block (the "0.10.0-beta.1 → explicit..." block) and the subsequent changelog
block to include a language label (e.g., change ``` to ```text) so both fenced
blocks declare a language; locate the fences near the content shown and replace
the opening ``` with ```text for those blocks (also apply the same change to the
second block referenced in the comment lines 75-82).
🪄 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: c0863721-78b2-431c-98f1-40b21dfa31c4
📒 Files selected for processing (6)
.github/workflows/release-please.yml.release-please-manifest.jsonRELEASE.mdbuild.gradlerelease-please-config.jsonsrc/main/java/dev/openfga/sdk/constants/FgaConstants.java
Description
What problem is being solved?
How is it being solved?
What changes are made to solve it?
References
Review Checklist
mainSummary by CodeRabbit