Skip to content

Commit e1e198d

Browse files
Added mds with client regeneration guide
1 parent 679b6f9 commit e1e198d

3 files changed

Lines changed: 782 additions & 0 deletions

File tree

README.md

Lines changed: 33 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -82,6 +82,10 @@ Show support for the Conductor OSS. Please help spread the awareness by starrin
8282
- [Example Unit Testing Application](#example-unit-testing-application)
8383
- [Workflow Deployments Using CI/CD](#workflow-deployments-using-cicd)
8484
- [Versioning Workflows](#versioning-workflows)
85+
- [Development](#development)
86+
- [Client Regeneration](#client-regeneration)
87+
- [Sync Client Regeneration](#sync-client-regeneration)
88+
- [Async Client Regeneration](#async-client-regeneration)
8589

8690
<!-- END doctoc generated TOC please keep comment here to allow auto update -->
8791

@@ -929,3 +933,32 @@ A powerful feature of Conductor is the ability to version workflows. You should
929933

930934
* Versioning allows safely testing changes by doing canary testing in production or A/B testing across multiple versions before rolling out.
931935
* A version can also be deleted, effectively allowing for "rollback" if required.
936+
937+
938+
## Development
939+
940+
### Client Regeneration
941+
942+
When updating to a new Orkes version, you may need to regenerate the client code to support new APIs and features. The SDK provides comprehensive guides for regenerating both sync and async clients:
943+
944+
#### Sync Client Regeneration
945+
946+
For the synchronous client (`conductor.client`), see the [Client Regeneration Guide](src/conductor/client/CLIENT_REGENERATION_GUIDE.md) which covers:
947+
948+
- Creating swagger.json files for new Orkes versions
949+
- Generating client code using Swagger Codegen
950+
- Replacing models and API clients in the codegen folder
951+
- Creating adapters and updating the proxy package
952+
- Running backward compatibility, serialization, and integration tests
953+
954+
#### Async Client Regeneration
955+
956+
For the asynchronous client (`conductor.asyncio_client`), see the [Async Client Regeneration Guide](src/conductor/asyncio_client/ASYNC_CLIENT_REGENERATION_GUIDE.md) which covers:
957+
958+
- Creating swagger.json files for new Orkes versions
959+
- Generating async client code using OpenAPI Generator
960+
- Replacing models and API clients in the http folder
961+
- Creating adapters for backward compatibility
962+
- Running async-specific tests and handling breaking changes
963+
964+
Both guides include detailed troubleshooting sections, best practices, and step-by-step instructions to ensure a smooth regeneration process while maintaining backward compatibility.

0 commit comments

Comments
 (0)