GezimSejdiu/setup-cli

Sets up the Databricks CLI in your GitHub Actions workflow.

setup-cli

setup-cli makes it easy to install the Databricks CLI in your environment.

It provides a composite GitHub Action and a portable installation script that can be used in most CI/CD systems and development environments.

Full documentation about installation can be found at:

• (AWS) https://docs.databricks.com/en/dev-tools/cli/install.html
• (Azure) https://learn.microsoft.com/en-us/azure/databricks/dev-tools/cli/install
• (GCP) https://docs.gcp.databricks.com/en/dev-tools/cli/install.html

Usage

This repository contains an install.sh script that can be invoked to install the Databricks CLI.

To install the latest version, run the following command:

curl -fsSL https://raw.githubusercontent.com/databricks/setup-cli/main/install.sh | sh

To install a specific version, you can replace main with a specific release tag:

curl -fsSL https://raw.githubusercontent.com/databricks/setup-cli/v0.221.1/install.sh | sh

GitHub Actions

This repository can be used from GitHub Actions.

For a complete example of how to use the Databricks CLI in a GitHub Actions workflow, see the following guide:

• (AWS) https://docs.databricks.com/en/dev-tools/bundles/ci-cd.html
• (Azure) https://learn.microsoft.com/en-us/azure/databricks/dev-tools/bundles/ci-cd
• (GCP) https://docs.gcp.databricks.com/en/dev-tools/bundles/ci-cd.html

To always use the latest version of the Databricks CLI, use the action from the main branch:

- uses: databricks/setup-cli@main

In case you need to use a specific version of the Databricks CLI, use the action from a release tag:

- uses: databricks/setup-cli@v0.221.1

Replace the tag with the version you want to use.

Alternatively, you can specify the version as a parameter to the action:

- uses: databricks/setup-cli@main
  with:
    version: 0.221.1

Using a Custom Registry (REGISTRY_URL)

You can also configure the action to download the Databricks CLI from a custom registry (e.g., an Artifactory or private mirror). This is helpful for environments where external resources like GitHub are restricted, or if you manage a private mirror.

To specify a custom registry, use the registry_url input:

- uses: databricks/setup-cli@main
  with:
    version: 0.221.1
    registry_url: 'https://your-private-registry.com/artifactory'

In this example, the CLI will be downloaded from the specified registry_url instead of GitHub. If registry_url is not provided, it defaults to https://github.com.

Preview notice

Please note that the Databricks CLI is in public preview as defined on https://docs.databricks.com/en/release-notes/release-types.html. This means that it has medium-to-high maturity and can be used in production.