openfga / openfga/python-sdk

Prevent generator syncs from regressing the README version

Open
#308 0 comments 0 reactions 1 assignee View on GitHub

@SoulPancake is already working on this.

Since Aug 3, 2026.

Dominant language
Python
Stars
85
Forks
36
Avg merge
3h 8m
Merged PRs (30d)
3

Description

Summary

The generator sync in python-sdk#307 regressed the README version.

The SDK README version must not be overwritten with an older generator-managed value.

Required changes

  • Define the owner of the Python SDK README version.
  • Prefer a release-please-managed SDK version when that is supported.
  • Prevent generator syncs from regressing the README version.
  • Define the process for README-only whitespace changes separately from version synchronization.

Related work

Generator tracking issue: to be linked after creation.

References

Acceptance criteria

  • A generator sync cannot downgrade or otherwise regress the README version.
  • The version update process has one documented source of truth.
  • The implementation or workflow has automated coverage for the regression case.

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Assessment

This issue has not been assessed yet.

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.