Skip to content

Latest commit

 

History

History
25 lines (17 loc) · 1.12 KB

RELEASING.md

File metadata and controls

25 lines (17 loc) · 1.12 KB
Raw

Step 1 - Re-generate the SDK source code

The source code from this repo is generated using OpenAPI generator and the Open API specification for the Tremendous API. The .py files can be re-generated and compiled with the following commands:

bin/generate

After that, please review the changes to double check that the changes to the API spec were generated correctly.

Please open a Pull Request with the file changes and wait for the test pipeline before merging it to main. Make sure to use Conventional Commit messages to help automating the process - specially feat: and fix:.

Step 2 - Merge the Release Please Pull Request

Release Please will maintain a "Release PR" that consolidates updates to CHANGELOG.md (based on the git history) and updating the version and project files.

When ready to publish a release, merge the Release PR and the release.yml workflow will publish a new package to PyPi and create a release on GitHub.