https://github.com/speakeasy-api/sdk-generation-action
Github action for Speakeasy Client SDK Generation, Release and Publishing
https://github.com/speakeasy-api/sdk-generation-action
github-actions openapi sdk
Last synced: 5 days ago
JSON representation
Github action for Speakeasy Client SDK Generation, Release and Publishing
- Host: GitHub
- URL: https://github.com/speakeasy-api/sdk-generation-action
- Owner: speakeasy-api
- License: apache-2.0
- Created: 2022-11-04T10:25:39.000Z (about 3 years ago)
- Default Branch: main
- Last Pushed: 2026-01-20T18:17:26.000Z (12 days ago)
- Last Synced: 2026-01-24T01:46:07.596Z (9 days ago)
- Topics: github-actions, openapi, sdk
- Language: Go
- Homepage: https://www.speakeasy.com/
- Size: 4.38 MB
- Stars: 22
- Watchers: 11
- Forks: 14
- Open Issues: 8
-
Metadata Files:
- Readme: README.md
- License: LICENSE
- Codeowners: CODEOWNERS
Awesome Lists containing this project
README
# Speakeasy SDK Generation Action & Workflows
> [!TIP]
> If you are a first-time user of Speakeasy and want to start setup from scratch, please see our [Quickstart Guide](https://www.speakeasy.com/docs/introduction). 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](https://github.com/speakeasy-api/speakeasy). 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 provide options 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 [separate repository](https://github.com/speakeasy-api/sdk-gen-config).
## Workflow Reference Documentation
### [Generation Workflow](https://www.speakeasy.com/docs/workflow-reference/generation-reference)
### [Publishing Workflow](https://www.speakeasy.com/docs/workflow-reference/publishing-reference)
# Developing in this Repo
To test
```
make test
```
This should open a PR on the [test action repository](https://github.com/speakeasy-api/sdk-generation-action-test-repo).
# When you're ready to test it as a live action
1) Push your changes up to a branch.
2) Navigate to the [test action](https://github.com/speakeasy-api/sdk-generation-action-test-repo/actions/workflows/action-test.yaml) in the test repo.
3) Click "run workflow" and put in your branch!