Sideko, Inc.

Your API Ecosystem, On Autopilot

Website | Docs

SDK Update Action

Automatically sync Sideko SDKs to the latest state of your API.

The action designed only for updates. If you do not yet have a Sideko generated SDK, install the sideko CLI and run sideko sdk init to get started!

Quick Start

1. Create a Sideko API key - In the Sideko UI, click the "API Keys" tab and create an API with scoped access to the API that the SDK is for.
2. Create a GitHub Token - Follow this guide from Github to retrieve a GitHub token.
3. Use the sample GitHub workflow to create your own SDK update action.

jobs:
  release:
    runs-on: ubuntu-latest
    steps:
      - uses: sideko-inc/sdk-update@v1
        with:
          repo: your-org/client-py
          language: python
          sdk-version: patch
          github-token: ${{ secrets.SDK_GITHUB_TOKEN }}
          sideko-api-key: ${{ secrets.SIDEKO_SERVICE_ACCOUNT_KEY }}

Inputs

Name	Description	Required	Default
repo	SDK repository to update (e.g. your-org/client-py)	✅
language	Programming language of the repository, see docs for permitted values	✅
sdk-version	Exact version to set the SDK (e.g. 1.4.2) or a release version for automatic version incrementing, see docs for permitted values	✅
github-token	GitHub token with appropriate access to the SDK repository, see below for details.	✅
sideko-api-key	Sideko API key with appropriate access to the API project, see below for details.	✅
sideko-config-path	Path to your SDK config file in the current repository.	❌	sdk-config.yaml
api-version	Version of the API in the Sideko project to generate from.	❌	latest
pr-title-template	Template for PR title. Use {type} for release type.	❌	SDK release ({type})
pr-auto-merge	Automatically merge the created PR into the SDK repository.	❌	false
pr-base-branch	Base branch to create SDK update PR against.	❌	main
pr-description	Description content (markdown) to include in SDK PR.	❌
branch-prefix	Prefix for the created branch names.	❌	sdk-release