Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/tclindner/sentry-releases-action

A GitHub action that creates releases for Sentry.io.
https://github.com/tclindner/sentry-releases-action

github-action github-actions github-releases releases sentry-cli sentry-client sentry-io

Last synced: 3 days ago
JSON representation

A GitHub action that creates releases for Sentry.io.

Host: GitHub
URL: https://github.com/tclindner/sentry-releases-action
Owner: tclindner
License: mit
Created: 2019-10-27T00:51:38.000Z (about 5 years ago)
Default Branch: master
Last Pushed: 2024-11-05T21:39:35.000Z (15 days ago)
Last Synced: 2024-11-09T19:11:58.271Z (11 days ago)
Topics: github-action, github-actions, github-releases, releases, sentry-cli, sentry-client, sentry-io
Language: JavaScript
Homepage:
Size: 12.1 MB
Stars: 39
Watchers: 4
Forks: 16
Open Issues: 9
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- Contributing: CONTRIBUTING.md
- License: LICENSE

Awesome Lists containing this project

README

# sentry-releases-action

[![license](https://img.shields.io/github/license/tclindner/sentry-releases-action.svg?maxAge=2592000&style=flat-square)](https://github.com/tclindner/sentry-releases-action/blob/master/LICENSE)

> A GitHub action that creates [releases for Sentry.io](https://docs.sentry.io/workflow/releases/?platform=javascript).

## What is sentry-releases-action?

A GitHub action that makes is easy to create a release in Sentry.io based on events in GitHub. Examples:

* a GitHub release is published
* a commit is pushed to master
* a pull request is merged to master

## How do I use it?

First thing first, let's make sure you have the necessary pre-requisites.

### Pre-requisites
Create a workflow `.yml` file in your repo's `.github/workflows` directory. An [example workflow](#example-workflow---create-a-release) is available below. For more information, reference the GitHub Help Documentation for [Creating a workflow file](https://help.github.com/en/articles/configuring-a-workflow#creating-a-workflow-file).

### Inputs

#### `tagName`

**Required** The tag being released. This is used as the Sentry release name. You can optionally prefix it using `releaseNamePrefix`.

#### `environment`

**Required** The name of the environment the release was deployed to.

#### `releaseNamePrefix`

**Optional** String that is prefixed to the tag to form the Sentry release name.

> Please review Sentry's documentation regarding max length and supported characters in release names.

For more information on these inputs, see the [API Documentation](https://developer.github.com/v3/repos/releases/#input)

#### `sourceMapOptions`

**Optional** A JSON object containing options to control [source map uploading](https://docs.sentry.io/cli/releases/#sentry-cli-sourcemaps).

Refer to [Sentry's CLI JS](https://github.com/getsentry/sentry-cli/blob/1f5cdbb6897e41a7e9a3892aea3b34b4c0341207/js/releases/index.js#L114-L144) for possible values. The only required value is `include` which is an array of paths to upload source maps from.

### Environment Variables

#### `SENTRY_AUTH_TOKEN`

**Required** Sentry auth token. The token needs the `org:read` and `project:releases` scopes.

#### `SENTRY_ORG`

**Required** Sentry organization.

#### `SENTRY_PROJECT`

**Required** Sentry project name.

#### `SENTRY_URL`

**Optional** URL to the Sentry instance, useful for e.g. on-prem deployments.

## Example usage

```yml
name: Create a Sentry.io release
uses: tclindner/[email protected]
env:
SENTRY_AUTH_TOKEN: ${{ secrets.SENTRY_AUTH_TOKEN }}
SENTRY_ORG: myAwesomeOrg
SENTRY_PROJECT: myAwesomeProject
with:
tagName: ${{ github.ref }}
environment: qa
```

> Note: `sentry-releases-action` will automatically trim `refs/tags/` from `tagName`. This means you can pass `GITHUB_REF` directly from release events without the need of mutating it first.

If you prefer to use the commit as the release name, use `${{ github.sha }}` for the `tagName` parameter.

### Full example workflow

On every GitHub `release` event.

```yaml
name: ReleaseWorkflow

on:
release:
types: [published, prereleased]

jobs:
createSentryRelease:
runs-on: ubuntu-latest
steps:
- name: Checkout code
uses: actions/checkout@master
- name: Create a Sentry.io release
uses: tclindner/[email protected]
env:
SENTRY_AUTH_TOKEN: ${{ secrets.SENTRY_AUTH_TOKEN }}
SENTRY_ORG: myAwesomeOrg
SENTRY_PROJECT: myAwesomeProject
with:
tagName: ${{ github.ref }}
environment: qa
```

Assume you tagged your release as `v1.0.0`. `github.ref` would equal `refs/tags/v1.0.0`. This action automatically strips `refs/tags/`, so the Sentry release name is `v1.0.0`.

### Example workflow with optional release prefix

On every GitHub `release` event.

```yaml
name: ReleaseWorkflow

on:
release:
types: [published, prereleased]

Scenario 1: Assume you tagged your release as `v1.1.0`. `github.ref` would equal `refs/tags/v1.1.0`. This action automatically strips `refs/tags/`, so the Sentry release name is `myAwesomeProject-v1.1.0`.

Scenario 2: Assume you tagged your release as `1.1.0` and you set `releaseNamePrefix` to `myAwesomeProject@`. `github.ref` would equal `refs/tags/1.1.0`. This action automatically strips `refs/tags/`, so the Sentry release name is `[email protected]`.

> Note: This action only works on Linux x86_64 systems.

### Example workflow with optional sourcemap upload

On every GitHub `release` event.

```yaml
name: ReleaseWorkflow

on:
release:
types: [published, prereleased]

As noted above, refer to [Sentry's CLI JS](https://github.com/getsentry/sentry-cli/blob/1f5cdbb6897e41a7e9a3892aea3b34b4c0341207/js/releases/index.js#L114-L144) for possible values. `include` is the only required value.

> Note: This action only works on Linux x86_64 systems.

## Related

[sentry-release-deploy-action](https://github.com/tclindner/sentry-release-deploy-action) - Action used create a deploy for an existing release created by this action.

## Contributing

Please see [CONTRIBUTING.md](CONTRIBUTING.md).

## Release History

Please see [CHANGELOG.md](CHANGELOG.md).

## License