Skip to content

docs: add SDK regeneration and release workflow - #14

Merged
thom-techlete merged 3 commits into
mainfrom
docs/sdk-generation-workflow
Sep 11, 2026
Merged

thom-techlete merged 3 commits into
mainfrom
docs/sdk-generation-workflow

Conversation

@thom-techlete

Copy link
Copy Markdown
Collaborator

Summary

Document the standard workflow for regenerating the Zero Friction Python SDK from updated OpenAPI specifications.

This adds guidance for:

  • branch-first SDK regeneration instead of regenerating directly on main;
  • keeping OpenAPI Generator pinned to the currently used version (7.13.0);
  • regenerating one client or all eight generated clients;
  • reviewing generated diffs for SDK-surface changes;
  • validating the regenerated SDK against dependent repositories before merge;
  • tagging the current SDK as v1 and the next validated regeneration as v1.1 after merge;
  • preferring release tags over main for stable downstream installs.

Files

  • docs/8_sdk_generation.md
  • README.md
  • CONTRIBUTING.md

This PR only changes documentation; it does not regenerate the SDK itself.

@github-actions github-actions Bot added the docs label Sep 11, 2026
@thom-techlete
thom-techlete merged commit 92a5e81 into main Sep 11, 2026
7 checks passed
@thom-techlete
thom-techlete deleted the docs/sdk-generation-workflow branch September 11, 2026 09:30
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant