Skip to content

Commit

Permalink
Clarify GH actions doc (#2906)
Browse files Browse the repository at this point in the history
* dotnet submodule

Signed-off-by: Hannah Hunter <[email protected]>

* attempt to clarify doc

Signed-off-by: Hannah Hunter <[email protected]>

* Revert "dotnet submodule"

This reverts commit 8fdeb61.

Signed-off-by: Hannah Hunter <[email protected]>
  • Loading branch information
hhunter-ms authored Oct 20, 2022
1 parent 1fdcfbd commit 63495e4
Showing 1 changed file with 16 additions and 5 deletions.
Original file line number Diff line number Diff line change
Expand Up @@ -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

Expand All @@ -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
```
```

## Next steps

Learn more about [GitHub Actions](https://docs.github.com/en/actions).

0 comments on commit 63495e4

Please sign in to comment.