From 63495e4d595bb146a3fadbbdaad93b1a93aa59c1 Mon Sep 17 00:00:00 2001 From: Hannah Hunter <94493363+hhunter-ms@users.noreply.github.com> Date: Thu, 20 Oct 2022 14:47:57 -0500 Subject: [PATCH] Clarify GH actions doc (#2906) * dotnet submodule Signed-off-by: Hannah Hunter * attempt to clarify doc Signed-off-by: Hannah Hunter * Revert "dotnet submodule" This reverts commit 8fdeb6182d23da53b304349c9576a07f0ffc2055. Signed-off-by: Hannah Hunter --- .../integrations/github_actions.md | 21 ++++++++++++++----- 1 file changed, 16 insertions(+), 5 deletions(-) diff --git a/daprdocs/content/en/developing-applications/integrations/github_actions.md b/daprdocs/content/en/developing-applications/integrations/github_actions.md index 1853dd71862..b0424bef009 100644 --- a/daprdocs/content/en/developing-applications/integrations/github_actions.md +++ b/daprdocs/content/en/developing-applications/integrations/github_actions.md @@ -3,14 +3,21 @@ type: docs weight: 5000 title: "Use the Dapr CLI in a GitHub Actions workflow" linkTitle: "GitHub Actions" -description: "Learn how to add the Dapr CLI to your GitHub Actions to deploy and manage Dapr in your environments." +description: "Add the Dapr CLI to your GitHub Actions to deploy and manage Dapr in your environments." --- -Dapr can be integrated with GitHub Actions via the [Dapr tool installer](https://github.com/marketplace/actions/dapr-tool-installer) available in the GitHub Marketplace. This installer adds the Dapr CLI to your workflow, allowing you to deploy, manage, and upgrade Dapr across your environments. +Dapr can be integrated with GitHub Actions via the [Dapr tool installer](https://github.com/marketplace/actions/dapr-tool-installer) available in the GitHub Marketplace. This installer adds the Dapr CLI to your workflow, allowing you to deploy, manage, and upgrade Dapr across your environments. -## Overview +Copy and paste the following installer snippet into your applicatin's YAML file to get started: -The `dapr/setup-dapr` action will install the specified version of the Dapr CLI on macOS, Linux and Windows runners. Once installed, you can run any [Dapr CLI command]({{< ref cli >}}) to manage your Dapr environments. +```yaml +- name: Dapr tool installer + uses: dapr/setup-dapr@v1 +``` + +The [`dapr/setup-dapr` action](https://github.com/dapr/setup-dapr) will install the specified version of the Dapr CLI on macOS, Linux, and Windows runners. Once installed, you can run any [Dapr CLI command]({{< ref cli >}}) to manage your Dapr environments. + +Refer to the [`action.yml` metadata file](https://github.com/dapr/setup-dapr/blob/main/action.yml) for details about all the inputs. ## Example @@ -34,4 +41,8 @@ The `dapr/setup-dapr` action will install the specified version of the Dapr CLI dapr status --kubernetes working-directory: ./twitter-sentiment-processor/demos/demo3 -``` \ No newline at end of file +``` + +## Next steps + +Learn more about [GitHub Actions](https://docs.github.com/en/actions). \ No newline at end of file