OpenAPI Generator Release Management — Versioning and Publishing Generated SDKs

In this tutorial, you will learn about OpenAPI Generator Release Management. We cover key concepts, practical examples, and best practices to help you master this topic.

OpenAPI Generator release management automates versioning, building, publishing, and documenting generated SDKs to package registries with semantic versioning aligned to API specification changes.

What You'll Learn

• Semantic versioning for generated SDKs
• Automated version bumping on spec changes
• Publishing to PyPI, npm, Maven, NuGet
• Changelog generation from spec diffs
• Release automation in CI/CD

Why It Matters

Manual SDK release processes are error-prone and don't scale. Each spec change may require new SDK versions across 8+ languages. Automated release management ensures partners always have access to the latest SDK. DodaTech publishes SDK releases to 5 registries within 5 minutes of spec merge.

flowchart LR
    A["Spec Change Detected"] --> B{"Breaking
change?"}
    B -->|"Yes"| C["Major version bump (v2.0.0)"]
    B -->|"No"| D{"New features?"}
    D -->|"Yes"| E["Minor version bump (v1.1.0)"]
    D -->|"No"| F["Patch version bump (v1.0.1)"]

    C --> G["Generate all SDKs"]
    E --> G
    F --> G
    G --> H["Run contract tests"]
    H --> I["Generate changelog"]
    I --> J["Publish to registries"]
    J --> K["Create GitHub release"]
    K --> L["Notify partners"]

What's Next

Set up release management in your {{< ilink "OpenAPI" "OpenAPI Generator Workflows" }} and review {{< ilink "OpenAPI" "OpenAPI Generator Testing" }} for release quality gates.