Skip to content

Commit 9d7b8b1

Browse files
authored
Merge pull request #36 from cswatt/patch-1
docs readme review
2 parents 2fdcd83 + 8f383e4 commit 9d7b8b1

File tree

1 file changed

+8
-8
lines changed

1 file changed

+8
-8
lines changed

README.md

Lines changed: 8 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -1,14 +1,15 @@
11
# Datadog Upload dSYMs Github Action
22
[![](https://github.com/DataDog/upload-dsyms-github-action/workflows/build-test/badge.svg)](https://github.com/Datadog/upload-dsyms-github-action/actions)
33

4-
This Datadog Github Action uploads dSYM files to Datadog in order to symbolicate crash reports.
5-
> This action runs on a `macos` environment only.
4+
This Datadog GitHub Action uploads dSYM files to Datadog to symbolicate crash reports.
5+
> This action runs only on `macos` environments.
66
77
## Setup
88

9-
An [API key](https://app.datadoghq.com/organization-settings/api-keys) is required to upload dSYM files to Datadog. Make sure to store this key in a secure storage, such as [Github Secrets](https://docs.github.com/en/actions/security-guides/encrypted-secrets).
9+
An [API key](https://app.datadoghq.com/organization-settings/api-keys) is required to upload dSYM files to Datadog. Store this key securely; for example, by using [GitHub encrypted secrets](https://docs.github.com/en/actions/security-guides/encrypted-secrets).
1010

11-
It is possible to configure the action to use Datadog EU by defining the `site` parameter to `datadoghq.eu`. By default the upload is sent to Datadog US.
11+
12+
By default, the upload is sent to Datadog US ('datadoghq.com'). To configure this Action to use Datadog EU, set the `site` parameter to `datadoghq.eu`.
1213

1314
## Usage
1415

@@ -41,7 +42,6 @@ jobs:
4142
|name|type|requirement|description|
4243
|---|---|---|---|
4344
|`api_key`|string|required|Datadog API key. Use a secret storage to store this parameter.|
44-
|`site`|string|optional|Datadog site region. `datadoghq.com` by default, use `datadoghq.eu` for the EU.|
45-
|`dsym_paths`|list|required|List of dSYM files path to upload. Support paths to folder and/or to zip files.|
46-
|`dry_run`|boolean|optional|If `true`, it will run the command without the final step of upload. All other checks are performed.|
47-
45+
|`site`|string|optional|Datadog site region. Defaults to `datadoghq.com`; use `datadoghq.eu` for the EU.|
46+
|`dsym_paths`|list|required|List of dSYM files path to upload. Supports paths to folders and/or to zip files.|
47+
|`dry_run`|Boolean|optional|If `true`, the command runs without the final upload step. All other checks are performed.|

0 commit comments

Comments
 (0)