From f34d3de49913fdf8b69245d20a249a4fce4bcc8b Mon Sep 17 00:00:00 2001 From: Pieter Noordhuis Date: Thu, 6 Jun 2024 11:04:47 +0200 Subject: [PATCH 1/5] Improve README --- README.md | 49 +++++++++++++++++++++++++++++++++++++------------ install.sh | 2 +- 2 files changed, 38 insertions(+), 13 deletions(-) diff --git a/README.md b/README.md index b9d4666..358ca51 100644 --- a/README.md +++ b/README.md @@ -1,31 +1,56 @@ # setup-cli -This is a composite GitHub Action that sets up the Databricks CLI (preview version `>=0.100`) in your GitHub Actions workflow. +Easily install the [Databricks CLI](https://github.com/databricks/cli) in your environment. + +Full documentation 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 -In your GitHub Actions workflow, use the following step: +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: + +```bash +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: + +```bash +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. + +To always use the latest version of the Databricks CLI, use the action from the `main` branch: ```yml - uses: databricks/setup-cli@main ``` - ## Preview notice -Please note that the Databricks CLI and Databricks asset bundles are 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. +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. diff --git a/install.sh b/install.sh index 03f5ce9..08295ee 100755 --- a/install.sh +++ b/install.sh @@ -63,7 +63,7 @@ if [ ! -w "$TARGET" ]; then echo "Please run this script through 'sudo' to allow writing to $TARGET." echo echo "If you're running this script from a terminal, you can do so using" - echo " curl -fsSL https://raw.githubusercontent.com/databricks/setup-cli/main/install.sh | sudo sh" + echo " curl -fsSL https://raw.githubusercontent.com/databricks/setup-cli/v${VERSION}/install.sh | sudo sh" exit 1 fi From 6986f286d51e6db767cef786b44912b7c3d99581 Mon Sep 17 00:00:00 2001 From: Pieter Noordhuis Date: Thu, 6 Jun 2024 11:08:26 +0200 Subject: [PATCH 2/5] About installation --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index 358ca51..8d411f1 100644 --- a/README.md +++ b/README.md @@ -2,7 +2,7 @@ Easily install the [Databricks CLI](https://github.com/databricks/cli) in your environment. -Full documentation can be found at: +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 From 2596c47173cac02591b264994a75df580a120506 Mon Sep 17 00:00:00 2001 From: Pieter Noordhuis Date: Thu, 6 Jun 2024 12:35:41 +0200 Subject: [PATCH 3/5] Link to docs about GitHub Actions --- README.md | 5 +++++ 1 file changed, 5 insertions(+) diff --git a/README.md b/README.md index 8d411f1..10404b1 100644 --- a/README.md +++ b/README.md @@ -27,6 +27,11 @@ curl -fsSL https://raw.githubusercontent.com/databricks/setup-cli/v0.221.1/insta 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: ```yml From 87245e36cead0ae857c1a42d3cbedcfe809052ea Mon Sep 17 00:00:00 2001 From: Pieter Noordhuis Date: Mon, 10 Jun 2024 08:33:53 +0200 Subject: [PATCH 4/5] Wordsmithing --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index 10404b1..28ba24f 100644 --- a/README.md +++ b/README.md @@ -38,7 +38,7 @@ To always use the latest version of the Databricks CLI, use the action from the - uses: databricks/setup-cli@main ``` -To pin the version of the Databricks CLI, use the action from a release tag: +In case you need to use a specific version of the Databricks CLI, use the action from a release tag: ```yml - uses: databricks/setup-cli@v0.221.1 From 8dbe0363e1369f8f08823499ec851bf36619cdc2 Mon Sep 17 00:00:00 2001 From: Pieter Noordhuis Date: Tue, 11 Jun 2024 14:56:05 +0200 Subject: [PATCH 5/5] Update README.md --- README.md | 4 +++- 1 file changed, 3 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index 28ba24f..b64c3b4 100644 --- a/README.md +++ b/README.md @@ -1,6 +1,8 @@ # setup-cli -Easily install the [Databricks CLI](https://github.com/databricks/cli) in your environment. +setup-cli makes it easy to install the [Databricks CLI](https://github.com/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