https://github.com/EmberExperts/ember-cli-deploy-sentry-cli
Sentry CLI integration for ember-cli-deploy. Integrate your deploy pipeline with Sentry. Upload sourcemaps, assign related commits and manage releases.
https://github.com/EmberExperts/ember-cli-deploy-sentry-cli
emberjs sentry-cli
Last synced: 12 months ago
JSON representation
Sentry CLI integration for ember-cli-deploy. Integrate your deploy pipeline with Sentry. Upload sourcemaps, assign related commits and manage releases.
- Host: GitHub
- URL: https://github.com/EmberExperts/ember-cli-deploy-sentry-cli
- Owner: EmberExperts
- License: mit
- Created: 2019-11-12T10:14:37.000Z (over 6 years ago)
- Default Branch: master
- Last Pushed: 2023-03-04T05:10:15.000Z (almost 3 years ago)
- Last Synced: 2025-02-26T10:45:28.506Z (12 months ago)
- Topics: emberjs, sentry-cli
- Language: JavaScript
- Homepage:
- Size: 1.19 MB
- Stars: 9
- Watchers: 3
- Forks: 12
- Open Issues: 9
-
Metadata Files:
- Readme: README.md
- License: LICENSE.md
Awesome Lists containing this project
README
# ember-cli-deploy-sentry-cli
Integrate your deploy pipeline with Sentry. Upload sourcemaps, assign related commits and manage releases.
# Compatibility
* ember-cli-deploy v1.0 or above
* Node.js v12 or above
## Installation
```
ember install ember-cli-deploy-sentry-cli
```
## Usage
Turn on `sourcemaps` generation in `ember-cli-build.js` config:
```js
{
sourcemaps: {
enabled: true,
extensions: ['js']
}
}
```
Add plugin config to your `config/deploy.js`:
```js
{
'sentry-cli': {
appName: 'sentry-app-name',
orgName: 'sentry-org-name',
authToken: process.env.SENTRY_AUTH_TOKEN,
urlPrefix: '', // if you need prefix for Sentry to catch like ~/assets
// url: 'https://your-custom-sentry-server.test/` // in case of self-hosted server
}
}
```
Optionaly set revision type to `version-commit` to have unified versioning pattern:
```js
{
'revision-data': {
type: 'version-commit'
}
}
```
Leave the rest for sentry-cli ;) Deploy! 🚀✌️
## FAQ & Possible errors
#### 1. `You do not have permission to perform this action`
Make sure your authToken is present [https://sentry.io/settings/account/api/auth-tokens/](https://sentry.io/settings/account/api/auth-tokens/) and has following scopes: `org:read` and `project:releases`
#### 2. `Could not determine any commits to be associated automatically.`
Your application repository needs to be connected on Sentry to your ogranization account and connected with the project.
#### 3. Your app's issues and not correctly related with app deploy version
Make sure your app's `moudlePrefix` is equal to your Sentry `appName`, and your `revision-data` `type` in `config/deploy.js` is using the same versioning strategy. In most cases you should use `version-commit`
## BONUS: Integrate your app with Sentry
1. Install Sentry:
`npm i @sentry/browser @sentry/integrations`
2. Add sentry config to `config/environment.js` file
```js
// config/environment.js
// Add following config
{
sentry: {
dsn: 'your-app-dsn'
}
}
```
3. Configure Sentry instance with defaults.
**Remember to define `environment` and `release`**
```js
// app/sentry.js
import * as Sentry from '@sentry/browser';
import { Ember } from '@sentry/integrations/esm/ember';
import config from 'web-app/config/environment';
const sentryConfig = config.sentry || {};
export function startSentry() {
Sentry.init({
environment: config.environment,
release: `${config.modulePrefix}@${config.APP.version}`,
...sentryConfig,
integrations: [new Ember()]
});
}
```
4. Initialize Sentry at the begining of `app/app.js` file
```js
// app/app.js
import { startSentry } from './sentry';
startSentry();
```
More info: https://simplabs.com/blog/2019/07/15/sentry-and-ember
## License
This project is licensed under the [MIT License](LICENSE.md).