Install STACKIT CLI Action

This GitHub Action installs the STACKIT CLI on a GitHub Actions runner. It is designed to be compatible with both Ubuntu (apt-get) and Alpine Linux (apk) environments.

Usage

To use this action in your workflow, reference it as a step. You can optionally specify a version of the CLI to install.

You can also specify service account key credentials and a STACKIT project ID. The action will configure the STACKIT CLI so you can immediately use the CLI in your workflows with minimal setup.

Basic usage

- name: Install STACKIT CLI
  uses: https://stackit-solutions.git.onstackit.cloud/actions/install-stackit-cli@v1

Installing a specific version

- name: Install STACKIT CLI
  uses: https://stackit-solutions.git.onstackit.cloud/actions/install-stackit-cli@v1
  with:
    version: "v0.64.0"

Installing and authenticating with a service account key

Setting a service account key will add a STACKIT_SERVICE_ACCOUNT_KEY_PATH environment variable to your workflow. This variable can be reused by other tools that integrate with the STACKIT APIs, e.g. the STACKIT Go SDK.

- name: Install STACKIT CLI
  uses: https://stackit-solutions.git.onstackit.cloud/actions/install-stackit-cli@v1
  with:
    version: "v0.64.0"
    stackit_service_account_key: ${{ secrets.STACKIT_SERVICE_ACCOUNT_KEY }}

Installing and authenticating with a service account key path

Using the stackit_service_account_key input will create a service account key file at a random location. If your workflow needs your service account key file to be at a precise location, use the following code.

- name: Set up service account key file
  env:
    STACKIT_SERVICE_ACCOUNT_KEY: ${{ secrets.STACKIT_SERVICE_ACCOUNT_KEY }}
  run: |
    printf '$s\n' "$STACKIT_SERVICE_ACCOUNT_KEY" > /tmp/stackit-sa-key.json
- name: Install STACKIT CLI
  uses: https://stackit-solutions.git.onstackit.cloud/actions/install-stackit-cli@v1
  with:
    version: "v0.64.0"
    stackit_service_account_key_path: /tmp/stackit-sa-key.json

Installing and setting a STACKIT project ID

This allows you to immediately start managing resources in a specific project.

- name: Install STACKIT CLI
  uses: https://stackit-solutions.git.onstackit.cloud/actions/install-stackit-cli@v1
  with:
    version: "v0.64.0"
    stackit_service_account_key: ${{ secrets.STACKIT_SERVICE_ACCOUNT_KEY }}
    stackit_project_id: ${{ vars.STACKIT_PROJECT_ID }}

Installing and retrieving the installed version

- name: Install STACKIT CLI
  id: install
  uses: https://stackit-solutions.git.onstackit.cloud/actions/install-stackit-cli@v1
- name: Print installed version
  env:
    INSTALLED_VERSION: ${{ steps.install.outputs.installed_version }}
  run: |
    echo "Using STACKIT CLI $INSTALLED_VERSION"

Inputs

Name	Description	Required	Default
version	The specific version of STACKIT CLI to install (e.g., v0.64.0). If left empty, the latest stable version will be installed.	No	""
stackit_service_account_key	STACKIT service account key to authenticate with. Overrides service_account_key_path, if set.	No	""
stackit_service_account_key_path	Path to STACKIT service account key to authenticate with.	No	""
stackit_project_id	STACKIT project ID to configure CLI with.	No	""

Outputs

Name	Description
installed_version	Installed version of the STACKIT CLI.