Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/speakeasy-api/sdk-generation-action
Github action for Speakeasy Client SDK management
https://github.com/speakeasy-api/sdk-generation-action
github-actions openapi sdk
Last synced: about 1 month ago
JSON representation
Github action for Speakeasy Client SDK management
- 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 2 years ago)
- Default Branch: main
- Last Pushed: 2024-11-20T00:10:11.000Z (about 2 months ago)
- Last Synced: 2024-11-30T19:44:53.539Z (about 1 month ago)
- Topics: github-actions, openapi, sdk
- Language: Go
- Homepage:
- Size: 883 KB
- Stars: 11
- Watchers: 12
- Forks: 6
- Open Issues: 2
-
Metadata Files:
- Readme: README.md
- License: LICENSE
- Codeowners: CODEOWNERS
Awesome Lists containing this project
README
# Speakeasy SDK Generation Action & Workflows
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 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.
For more information please see our docsite linked below.
## Workflow usage
### [Generation Workflow Documentation](https://www.speakeasy.com/docs/workflow-reference/generation-reference)
### [Publishing Workflow](https://www.speakeasy.com/docs/workflow-reference/publishing-reference)