Skip to content

chore: add release type and package name to config#267

Open
SoulPancake wants to merge 2 commits intomainfrom
chore/use-packagename-to-avoid-branch-suffix
Open

chore: add release type and package name to config#267
SoulPancake wants to merge 2 commits intomainfrom
chore/use-packagename-to-avoid-branch-suffix

Conversation

@SoulPancake
Copy link
Copy Markdown
Member

@SoulPancake SoulPancake commented Apr 11, 2026

Description

What problem is being solved?

How is it being solved?

What changes are made to solve it?

References

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

  • Chores
    • Updated internal release configuration to improve changelog generation and package metadata handling.

Copilot AI review requested due to automatic review settings April 11, 2026 19:04
@SoulPancake SoulPancake requested a review from a team as a code owner April 11, 2026 19:04
@coderabbitai
Copy link
Copy Markdown
Contributor

coderabbitai bot commented Apr 11, 2026

Walkthrough

The release-please configuration for the root package is updated to explicitly set package-name to an empty string and adds a new hidden release changelog section entry under the "Miscellaneous" section, alongside the existing hidden chore entry.

Changes

Cohort / File(s) Summary
Release Configuration
release-please-config.json
Added package-name field set to empty string for root package; added hidden release entry to changelog-sections under "Miscellaneous" cohort.

Estimated code review effort

🎯 1 (Trivial) | ⏱️ ~3 minutes

Possibly related PRs

Suggested reviewers

  • evansims
  • rhamzeh
🚥 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 'chore: add release type and package name to config' accurately describes the main changes made to release-please-config.json, which added package-name configuration.
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
  • Commit unit tests in branch chore/use-packagename-to-avoid-branch-suffix

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.

@codecov-commenter
Copy link
Copy Markdown

codecov-commenter commented Apr 11, 2026

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 69.84%. Comparing base (4a13743) to head (cb254d0).

Additional details and impacted files
@@           Coverage Diff           @@
##             main     #267   +/-   ##
=======================================
  Coverage   69.84%   69.84%           
=======================================
  Files         140      140           
  Lines       10743    10743           
=======================================
  Hits         7503     7503           
  Misses       3240     3240           

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

🚀 New features to boost your workflow:
  • ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.

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

Updates the repository’s release-please configuration to better align Conventional Commit grouping with this repo’s release workflow and to explicitly set package metadata for the root package.

Changes:

  • Add a package-name field under the root packages["."] configuration.
  • Add a release Conventional Commit type to changelog-sections (hidden).

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

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.

Actionable comments posted: 1

🤖 Prompt for all review comments with AI agents
Verify each finding against the current code and only fix it if needed.

Inline comments:
In `@release-please-config.json`:
- Around line 21-22: Remove the dead mapping for the "release" conventional
commit type from the release-please configuration by deleting the JSON entry
with "type": "release" (the object { "type": "release", "section":
"Miscellaneous", "hidden": true }). Ensure only the unused mapping is removed
and the surrounding JSON array remains valid (comma placement adjusted if
needed).
🪄 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: b635caa0-a064-4b00-b670-c5018074d890

📥 Commits

Reviewing files that changed from the base of the PR and between 4a13743 and cb254d0.

📒 Files selected for processing (1)
  • release-please-config.json

Comment on lines +21 to +22
{ "type": "chore", "section": "Miscellaneous", "hidden": true },
{ "type": "release", "section": "Miscellaneous", "hidden": true }
Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

⚠️ Potential issue | 🟡 Minor

🧩 Analysis chain

🏁 Script executed:

#!/bin/bash
set -euo pipefail

echo "== Recent commit subjects using release: type =="
git log --pretty=format:%s -n 500 | rg -n '^release(\([^)]+\))?:\s' || true

echo
echo "== Commitlint/conventional-commit config references (if present) =="
rg -n --iglob '*commitlint*' --iglob '*.js' --iglob '*.cjs' --iglob '*.json' 'type-enum|release'

Repository: openfga/python-sdk

Length of output: 472


Remove the unused release type mapping on line 22.

The repository's last 500 commits contain no release: conventional commit types, and no commitlint configuration defines this type. This changelog mapping is dead config and can be removed for clarity.

Verification
== Recent commit subjects using release: type ==
(no matches found in last 500 commits)

== Commitlint/conventional-commit config references ==
release-please-config.json:22:        { "type": "release",  "section": "Miscellaneous", "hidden": true  }
🤖 Prompt for AI Agents
Verify each finding against the current code and only fix it if needed.

In `@release-please-config.json` around lines 21 - 22, Remove the dead mapping for
the "release" conventional commit type from the release-please configuration by
deleting the JSON entry with "type": "release" (the object { "type": "release",
"section": "Miscellaneous", "hidden": true }). Ensure only the unused mapping is
removed and the surrounding JSON array remains valid (comma placement adjusted
if needed).

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.

4 participants