The sdk-generation-action provides both an action and a workflow 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.

You can find more information about our Client SDK Generator for OpenAPI Documents here: https://docs.speakeasyapi.dev/docs/using-speakeasy/client-sdks/index.html

The included workflow provides options for publishing the SDKs to various package managers once the action is successful.

This action provides a self contained solution for automatically generating new versions of a client SDK either when either the reference OpenAPI doc is updated or the Speakeasy CLI that is used to generate the SDKs is updated.

The action runs through the following steps:

• Downloads the latest (or pinned) version of the Speakeasy CLI
• Clones the associated repo
• Downloads or loads the latest OpenAPI doc from a url or the repo
• Checks for changes to the OpenAPI doc and the Speakeasy CLI Version
• Generates a new SDK for the configured languages if necessary
• Creates a commit with the new SDK(s) and pushes it to the repo
• Optionally creates a Github release for the new commit

The version of the Speakeasy CLI to use or "latest". Default "latest".

Required The location of the OpenAPI document to use, either a relative path within the repo or a URL to a publicly hosted document.

Required A GitHub access token with write access to the repo.

Required A yaml string containing a list of languages to generate SDKs for example:

languages: |
  - go: ./go-sdk # specifying a output directory
  - python # using default output of ./python-client-sdk
  - typescript # using default output of ./typescript-client-sdk
  - java # using default output of ./java-client-sdk

If multiple languages are present we will treat the repo as a mono repo, if a single language is present as a single language repo.

Whether to create a release for the new SDK version. Default "true". This will also create a tag for the release, allowing the Go SDK to be retrieved via a tag with Go modules.

(Workflow Only) Whether to publish the Python SDK to PyPi. Default "false".

(Workflow Only) Whether to publish the TypeScript SDK to NPM. Default "false".

true if the Python SDK was regenerated

The directory the Python SDK was generated in

true if the Typescript SDK was regenerated

The directory the Typescript SDK was generated in

true if the Go SDK was regenerated

The directory the Go SDK was generated in

true if the Java SDK was regenerated

The directory the Java SDK was generated in

.github/workflows/speakeasy_sdk_generation.yml

name: Generate

on:
  workflow_dispatch: {} # Allows manual triggering of the workflow to generate SDK
  schedule:
    - cron: 0 0 * * * # Runs every day at midnight

jobs:
  generate:
    uses: speakeasy-api/sdk-generation-action/.github/workflows/sdk-generation.yaml@v5.2 # Import the sdk generation workflow which will handle the generation of the SDKs and publishing to the package managers
    with:
      speakeasy_version: latest
      openapi_doc_location: https://docs.speakeasyapi.dev/openapi.yaml
      languages: |-
        - python
      publish_python: true
    secrets:
      github_access_token: ${{ secrets.GITHUB_TOKEN }}
      pypi_token: ${{ secrets.PYPI_TOKEN }}

.github/workflows/speakeasy_sdk_generation.yml

name: Generate

on:
  workflow_dispatch: {} # Allows manual triggering of the workflow to generate SDK
  schedule:
    - cron: 0 0 * * * # Runs every day at midnight

jobs:
  generate:
    name: Generate SDK
    runs-on: ubuntu-latest
    steps:
      - uses: speakeasy-api/sdk-generation-action@v5.2
        with:
          speakeasy_version: latest
          openapi_doc_location: https://docs.speakeasyapi.dev/openapi.yaml
          github_access_token: ${{ secrets.GITHUB_TOKEN }}
          languages: |-
            - go