Skip to content

doc: add doc for how to update / maintain the SDK #183

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
brian-mulier-p merged 1 commit into from
Feb 27, 2026
Merged

doc: add doc for how to update / maintain the SDK #183

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
10 changes: 10 additions & 0 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -307,6 +307,16 @@ tasks:
}
```

## How to update the SDK
- Generate openapi from Kestra-EE: `./gradlew clean build updateOpenapiVersion -xtest`
- Move `kestra-ee.yml` from `webserver-ee/build/classes/java/main/META-INF/swagger` to the root of the SDK repository
- If you introduced a new controller with a new kind of entity and it has a new OpenAPI / Swagger tag, you should add it there `java/configuration/java-config.yml` (and for all SDK that must support it) in openapiNormalizer.FILTER (it's an opt-in for each tag)
- Generate the SDKs using `TMP=$(pwd) && $TMP/generate-sdks.sh 1.0.10 java && $TMP/generate-sdks.sh 1.0.12 javascript && $TMP/generate-sdks.sh 1.0.10 python && $TMP/generate-sdks.sh 1.0.1 go` (change the version to SDK-current-version + 1)
- Create the tests for the added functionality in each SDK tests folder
- Run tests of all SDKs: `TMP=~/IdeaProjects/client-sdk && cd $TMP/java/java-sdk && chmod 755 gradlew && ./run-tests.sh develop && cd $TMP/go-sdk && bash ./run-tests.sh develop && cd $TMP/javascript && bash ./run-tests.sh develop && cd $TMP/python/python-sdk && bash ./run-tests.sh develop`
- ⚠ If an existing test fails, you're probably introducing a breaking change (or someone's prior commit did). If that's the case, make sure it's safe to introduce that before merging
- Commit and make a PR

## License
Apache 2.0 © [Kestra Technologies](https://kestra.io)

Expand Down