Skip to content

Commit

Permalink
Update README with whats-new section
Browse files Browse the repository at this point in the history
  • Loading branch information
andreiborza committed Jan 14, 2025
1 parent e3c368a commit 5f0f0d8
Showing 1 changed file with 15 additions and 4 deletions.
19 changes: 15 additions & 4 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,8 @@
# Sentry Release GitHub Action

**NOTE**: Currently only available for Linux runners. See [this issue](https://github.com/getsentry/action-release/issues/58) for more details.
> [!IMPORTANT]
> This action is currently only availble for Linux runners.
> See [this issue](https://github.com/getsentry/action-release/issues/58) for more details.
Automatically create a Sentry release in a workflow.

Expand All @@ -13,11 +15,20 @@ A release is a version of your code that can be deployed to an environment. When

Additionally, releases are used for applying source maps to minified JavaScript to view original, untransformed source code. You can learn more about releases in the [releases documentation](https://docs.sentry.io/workflow/releases).

## What's new

* **feat(sourcemaps): Add inject option to inject debug ids into source files and sourcemaps**

A new option to inject Debug IDs into source files and sourcemaps was added to the action to ensure proper un-minifaction of your stacktraces. We **strongly recommend enabling** this by setting `inject: true` in your action alongside providing a path to sourcemaps.

Please refer to the [release page](https://github.com/getsentry/action-release/releases) for the latest release notes.

## Prerequisites

### Create a Sentry Internal Integration

NOTE: You have to be an admin in your Sentry org to create this.
> [!NOTE]
> You have to be an admin in your Sentry org to create this.
For this action to communicate securely with Sentry, you'll need to create a new internal integration. In Sentry, navigate to: _Settings > Developer Settings > Custom Integrations > Create New Integration > Internal Integration_.

Expand All @@ -32,7 +43,7 @@ Click “Save” at the bottom of the page, then go back into your newly created
Adding the following to your workflow will create a new Sentry release and tell Sentry that you are deploying to the `production` environment.

```yaml
- uses: actions/checkout@v3
- uses: actions/checkout@v4
with:
fetch-depth: 0

Expand Down Expand Up @@ -63,7 +74,7 @@ Adding the following to your workflow will create a new Sentry release and tell
|name| description |default|
|---|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---|
|`environment`| Set the environment for this release. E.g. "production" or "staging". Omit to skip adding deploy to release. |-|
|`inject`| Injects Debug IDs into source files and sourcemaps. We **strongly recommend** enabling this to ensure proper un-minifaction of your stacktraces. |`false`|
|`inject`| Injects Debug IDs into source files and sourcemaps. We **strongly recommend enabling** this to ensure proper un-minifaction of your stacktraces. |`false`|
|`sourcemaps`| Space-separated list of paths to JavaScript sourcemaps. Omit to skip uploading sourcemaps. |-|
|`finalize`| When false, omit marking the release as finalized and released. |`true`|
|`ignore_missing`| When the flag is set and the previous release commit was not found in the repository, will create a release with the default commits count instead of failing the command. |`false`|
Expand Down

0 comments on commit 5f0f0d8

Please # to comment.