Skip to content

feat: draft releases, version verification, and reusable workflows#287

Merged
rhamzeh merged 2 commits intomainfrom
feat/release-workflow-improvements
May 7, 2026
Merged

feat: draft releases, version verification, and reusable workflows#287
rhamzeh merged 2 commits intomainfrom
feat/release-workflow-improvements

Conversation

@SoulPancake
Copy link
Copy Markdown
Member

@SoulPancake SoulPancake commented May 4, 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
    • Enhanced release workflow with automated version verification to ensure consistency before publishing.
    • Enabled draft pull requests for release preparation.
    • Improved pull request validation for better code quality standards.

@SoulPancake SoulPancake requested a review from a team as a code owner May 4, 2026 17:20
Copilot AI review requested due to automatic review settings May 4, 2026 17:20
@coderabbitai
Copy link
Copy Markdown
Contributor

coderabbitai Bot commented May 4, 2026

Walkthrough

This pull request updates release and PR validation workflows. It adds version consistency verification for tagged releases, configures Release Please to generate draft pull requests, replaces the release creation step with a reusable undraft workflow, and delegates PR title validation to a reusable workflow from the SDK generator repository.

Changes

Release Workflow & Version Verification

Layer / File(s) Summary
Configuration
release-please-config.json
Added "draft": true to enable draft release pull requests.
Version Verification
.github/workflows/main.yaml
New verify-version job validates that Git tag, .release-please-manifest.json, and pyproject.toml versions match on tag pushes.
Publish & Release Integration
.github/workflows/main.yaml
publish job now depends on verify-version to block publishing until version consistency confirmed. Removed create-release job and added undraft-release job that delegates to openfga/sdk-generator/.github/workflows/undraft-release.yml@main.

PR Title Validation Refactor

Layer / File(s) Summary
Workflow Delegation
.github/workflows/pr-title-conventional-commit.yml
Replaced inline validate-pr-title job with a pr-title-check job that calls the reusable openfga/sdk-generator/.github/workflows/pr-title-check.yml@main workflow.

Possibly related PRs

  • openfga/python-sdk#262: Modifies release-please configuration and release workflows to improve release automation.
  • openfga/python-sdk#260: Modifies the PR title enforcement workflow by adding an inline pr-conventional-commits step.

Suggested reviewers

  • sergiught
  • rhamzeh

Estimated code review effort

🎯 2 (Simple) | ⏱️ ~12 minutes

🚥 Pre-merge checks | ✅ 5
✅ Passed checks (5 passed)
Check name Status Explanation
Description Check ✅ Passed Check skipped - CodeRabbit’s high-level summary is enabled.
Title check ✅ Passed The PR title directly and accurately summarizes the three main changes: draft releases, version verification, and reusable workflows. It is concise, specific, and clearly reflects the core modifications in the changeset.
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.
Linked Issues check ✅ Passed Check skipped because no linked issues were found for this pull request.
Out of Scope Changes check ✅ Passed Check skipped because no linked issues were found for this pull request.

✏️ 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 feat/release-workflow-improvements

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 updates the release/CI automation to support draft releases, add a tag/manifest/pyproject version consistency gate before publishing, and replace some in-repo workflow logic with reusable workflows from openfga/sdk-generator.

Changes:

  • Configure release-please to create draft releases ("draft": true).
  • Switch PR title conventional-commit validation to a reusable workflow.
  • Add a verify-version job before publishing on tag pushes and replace the release finalization step with an undraft reusable workflow.

Reviewed changes

Copilot reviewed 3 out of 3 changed files in this pull request and generated 3 comments.

File Description
release-please-config.json Enables draft behavior for release-please releases.
.github/workflows/pr-title-conventional-commit.yml Replaces inline PR title validation with a reusable workflow.
.github/workflows/main.yaml Adds version verification prior to publish and delegates undrafting to a reusable workflow.

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

Comment thread .github/workflows/pr-title-conventional-commit.yml
Comment thread .github/workflows/main.yaml Outdated
Comment thread .github/workflows/main.yaml
@SoulPancake SoulPancake requested a review from rhamzeh May 5, 2026 13:09
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: 2

🤖 Prompt for all review comments with AI agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.

Inline comments:
In @.github/workflows/main.yaml:
- Around line 120-125: The undraft-release job references a non-existent
workflow and will fail; update the job named undraft-release by either removing
the entire job block (undraft-release) or changing its uses value from
openfga/sdk-generator/.github/workflows/undraft-release.yml@main to the correct
workflow file openfga/sdk-generator/.github/workflows/release-please.yml@main
(and ensure any conditional/needs/permissions still apply) so the workflow
points to an existing release automation.

In @.github/workflows/pr-title-conventional-commit.yml:
- Around line 10-13: The referenced reusable workflow in the pr-title-check job
("uses: openfga/sdk-generator/.github/workflows/pr-title-check.yml@main") is
invalid and will fail at runtime; update the pr-title-check job by either
replacing the "uses" target with the correct reusable workflow path/name (or
correct repository) or remove the pr-title-check job and implement equivalent PR
title validation steps locally (e.g., a local step that validates commits/PR
title), ensuring changes are applied to the job named pr-title-check and its
"uses" entry.
🪄 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: 8d9ebb7e-6bc8-4f21-820f-a0ddf72fa517

📥 Commits

Reviewing files that changed from the base of the PR and between 42cb963 and e249cb8.

📒 Files selected for processing (3)
  • .github/workflows/main.yaml
  • .github/workflows/pr-title-conventional-commit.yml
  • release-please-config.json

Comment thread .github/workflows/main.yaml
Comment thread .github/workflows/pr-title-conventional-commit.yml
@rhamzeh rhamzeh added this pull request to the merge queue May 7, 2026
Merged via the queue into main with commit b9c7472 May 7, 2026
12 checks passed
@rhamzeh rhamzeh deleted the feat/release-workflow-improvements branch May 7, 2026 11:24
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