RFC: SDK Release Automation#33
Open
SoulPancake wants to merge 9 commits intomainfrom
Open
Conversation
There was a problem hiding this comment.
Pull request overview
Adds an RFC documenting a proposed standard release automation approach for OpenFGA SDKs (and related repos) using Release Please and a GitHub App-based workflow to generate release PRs, bump versions (including cross-language markers), and publish tags/releases in a consistent way.
Changes:
- Introduces an RFC describing a two-phase “Release PR → tag/publish” release model powered by Release Please.
- Specifies conventions for version bumping (
x-release-please-versionmarkers) and standardized GitHub-style changelogs. - Proposes enforcement of Conventional Commits via PR title validation and outlines migration/rollout steps.
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
You can also share your feedback on Copilot code review. Take the survey.
Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>
ewanharris
reviewed
Mar 18, 2026
SoulPancake
commented
Mar 23, 2026
sergiught
reviewed
Mar 26, 2026
rhamzeh
reviewed
Apr 2, 2026
Member
rhamzeh
left a comment
rhamzeh
left a comment
There was a problem hiding this comment.
Please add a section on security:
- Bot commits and tags MUST be GPG signed with our GPG public key
- Maintainers must not be able to push tags
- Both the bot and maintainers must not be able to push directly to main without a codeowner review
Co-authored-by: Raghd Hamzeh <raghd@rhamzeh.com>
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Description
RFC proposing the adoption of Release Please to automate the release process for all OpenFGA SDKs, CLI, and extensions.
What problem is being solved?
Releasing a new SDK version is currently a manual process — updating changelogs, bumping version constants, creating signed tags, and pushing them. This overhead discourages frequent releases and leads to large, batched shipments.
How is it being solved?
A
workflow_dispatch-triggered GitHub Actions workflow powered by Release Please. A maintainer selects a bump type from the UI, Release Please opens a Release PR with all version bumps and changelog updates, and merging the PR finalizes the release (tag + GitHub Release). Authentication uses a dedicated GitHub App for short-lived, least-privilege tokens.What changes are made to solve it?
This RFC covers the full design: workflow configuration,
x-release-please-versionmarkers for cross-language version bumping, changelog format standardization (GitHub format), Conventional Commits enforcement via PR title validation, GitHub App identity/signing, migration steps, and a phased rollout plan.Relevant issue: openfga/sdk-generator#679
References
Review Checklist
main