Skip to content
microsoft image/svg+xml

GitHub Action

Setup kiota

v0.5.0 Latest version

Setup kiota

microsoft image/svg+xml

Setup kiota

Installs Kiota OpenAPI client generator so it can be used in your workflow

Installation

Copy and paste the following snippet into your .yml file.

              
- name: Setup kiota

              
  uses: microsoft/[email protected]
Learn more about this action in microsoft/setup-kiota

Choose a version

Setup Kiota v0

GitHub Super-Linter CI

This actions sets up kiota so it can be used in your workflow. Kiota is a modern OpenAPI based client generator that supports multiple languages.

NOTE: This action is currently in public preview and subject to change.

Usage

steps:
  - uses: actions/checkout@v3

  - uses: microsoft/[email protected]

  - name: Update kiota clients in the repository
    run: kiota update -o . # for a complete documentation of the CLI commands see https://aka.ms/kiota/docs
    working-directory: src # assumes client is under the src path in your repository

Parameters

The action also supports the following parameters

version

Version of kiota to install.

steps:
  - uses: microsoft/[email protected]
    with:
      version: latest # (default) or a version like v1.5.1

includePreRelease

Whether or not to install a prerelease when available.

steps:
  - uses: microsoft/[email protected]
    with:
      includePreRelease: false 
      # (default) or true to use a prerelease if one is available.
      # MUST be false when the version set to anything other than 'latest'

Outputs

path

Full path to the installed kiota executable.

steps:
  - id: setup-kiota
    uses: microsoft/[email protected]
  - run: echo "${{ steps.setup-kiota.outputs.path }}"
  # result: /tmp/kiotabin/v1.6.1/linux-x64/kiota

version

The version that was resolved during installation.

steps:
  - id: setup-kiota
    uses: microsoft/[email protected]
  - run: echo "${{ steps.setup-kiota.outputs.version }}"
  # result: v1.6.1 or v1.6.0-preview.202309070001