Build APIs your users love ❤️ with Speakeasy
[!TIP] If you are are a first time user of Speakeasy and want to start setup from scratch, please see our Quickstart Guide. Following our quickstart guide will automatically setup this action and workflows for your API.
The sdk-generation-action provides both an action and workflows to generate Client SDKs from an OpenAPI document using the Speakeasy CLI tool. You can use these to manage CI/CD (ie the automatic generation and publishing of Client SDKs) in a repo containing the generated SDKs.
The included workflows provides option for publishing the SDKs to various package managers once the action is successful, either via PR or directly to the repo.
This action provides a self contained solution for automatically generating new versions of a client SDK when either the reference OpenAPI doc is updated or the Speakeasy CLI that is used to generate the SDKs is updated.
Configuration for the supported workflows is documented in seperate repository.
To test
make test
This should open a PR at https://github.com/speakeasy-api/sdk-generation-action-test-repo
Push your changes up to a branch
Navigate to https://github.com/speakeasy-api/sdk-generation-action-test-repo/actions/workflows/action-test.yaml in the test repo.
Click "run workflow" and put in your branch!