Skip to content

[Doc] Write example for Self-Hosted Sentry #84

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 2 commits into from
Apr 21, 2022
Merged

[Doc] Write example for Self-Hosted Sentry #84

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
4a56d7a
[Doc] Write example for Self-Hosted Sentry
sue445 Apr 19, 2022
1560185
Tweak description for `SENTRY_URL` and `SENTRY_PROJECT`
sue445 Apr 20, 2022
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
20 changes: 14 additions & 6 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -30,19 +30,20 @@ Adding the following to your workflow will create a new Sentry release and tell
SENTRY_AUTH_TOKEN: ${{ secrets.SENTRY_AUTH_TOKEN }}
SENTRY_ORG: ${{ secrets.SENTRY_ORG }}
SENTRY_PROJECT: ${{ secrets.SENTRY_PROJECT }}
# SENTRY_URL: https://sentry.io/
with:
environment: production
```

### Inputs
#### Environment Variables
The following are all _required_.
|name|description|default|
|---|---|---|
|`SENTRY_AUTH_TOKEN`|**[Required]** Authentication token for Sentry. See [installation](#create-a-sentry-internal-integration).|-|
|`SENTRY_ORG`|**[Required]** The slug of the organization name in Sentry.|-|
|`SENTRY_PROJECT`|The slug of the project name in Sentry. One of `SENTRY_PROJECT` or `projects` is required.|-|
|`SENTRY_URL`|The URL used to connect to Sentry. (Only required for [Self-Hosted Sentry](https://develop.sentry.dev/self-hosted/))|`https://sentry.io/`|

|name|description|
|---|---|
|`SENTRY_AUTH_TOKEN`|Authentication token for Sentry. See [installation](#create-a-sentry-internal-integration).|
|`SENTRY_ORG`|The slug of the organization name in Sentry.|
|`SENTRY_PROJECT`|The slug of the project name in Sentry.|
#### Parameters
|name|description|default|
|---|---|---|
Expand Down Expand Up @@ -76,6 +77,13 @@ The following are all _required_.
version: 'v1.0.1'
```

- Create a new Sentry release for [Self-Hosted Sentry](https://develop.sentry.dev/self-hosted/)
```yaml
- uses: getsentry/action-release@v1
env:
SENTRY_URL: https://sentry.example.com/
```

Comment on lines +80 to +86
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Looks great! Do you mind also adding to the 'Environment Variables' section a part that mentions SENTRY_URL? Here's my suggestion, though if you have a clearer way of conveying it, that works too 👍

#### Environment Variables
The following are all _required*_.
|name|description|
|---|---|
|`SENTRY_AUTH_TOKEN`|Authentication token for Sentry. See [installation](#create-a-sentry-internal-integration).|
|`SENTRY_ORG`|The slug of the organization name in Sentry.|
|`SENTRY_PROJECT`|The slug of the project name in Sentry.|
|`SENTRY_URL`*|The URL used to connect to Sentry, defaults to `https://sentry.io`.<br/>(Only required for [Self-Hosted Sentry](https://develop.sentry.dev/self-hosted/))|

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@leeandher I have added a description at 1560185. What do you think?

## Troubleshooting
Suggestions and issues can be posted on the repository's
[issues page](https://github.com/getsentry/action-release/issues).
Expand Down