CHANGELOG.md

@@ -1,5 +1,56 @@
 # ember-cli-deploy-sentry Changelog
 
+### 0.7.0
+- Add ability to associate a commit with a release [#62]
+- Make it obvious where to get the keys for hosted accounts [#59]
+- Update mock-fs to use more recent versions of Node.js [#55]
+- Upload on didPrepare hook to fix gzip issues  [#52]
+
+### 0.5.5
+- Remove jQuery usages [#45]
+
+### 0.5.4
+- Remove sentryApiKey from required config params [#43]
+- Add strictSSL option for request [#43]
+
+### 0.5.3
+- Remove </meta> to prevent IE10 from breaking [#40]
+
+### 0.5.2
+- Fix deprecation warning for ember-cli/lib/ext/promise [#35]
+- Add config documentation [#33]
+
+### 0.5.1
+- Remove documentation for `didDeployMessage` config option as its gone
+
+### 0.5.0
+Thanks to @kmiyashiro, @Turbo87 and especially @duizendnegen for making this release happen!
+
+- Add bearer token authentication [#21]
+- Support ember-cli-deploy-plugin 0.2.9 [#27]
+
+### 0.4.0
+
+- Gracefully handle reuploading sourcemaps for releases with assigned issues
+- Several logging improvements
+- Fix releaseMetaName not being respected by raven service
+- Several Documentation fixes
+
+### 0.3.1
+
+- Fix possibly broken tarball
+
+### 0.3.0
+
+- Rate limit uploaded sourcemaps
+- Update mock-fs dependency to support newer versions of node
+- Use prepare hook instead of didBuild hook to catch revision data
+- Fix windows issues by using form-data library directly
+
+### 0.2.1
+
+- Fix logging
+
 ### 0.2.0
 
 - Add service for usage with ember-cli-sentry

README.md

@@ -2,9 +2,7 @@
 
 > An ember-cli-deploy-plugin to upload javascript sourcemaps to [Sentry][1].
 
-<hr/>
-**WARNING: This plugin is only compatible with ember-cli-deploy versions >= 0.5.0**
-<hr/>
+[![](https://ember-cli-deploy.github.io/ember-cli-deploy-version-badges/plugins/ember-cli-deploy-sentry.svg)](http://ember-cli-deploy.github.io/ember-cli-deploy-version-badges/)
 
 ## What is an ember-cli-deploy plugin?
 
@@ -23,20 +21,27 @@ To get up and running quickly, do the following:
 $ ember install ember-cli-deploy-sentry
 ```
 
+- For hosted accounts, generate your bearer/api key here: https://sentry.io/api/
 - Place the following configuration into `config/deploy.js`
 
 ```javascript
-ENV.sentry {
+ENV.sentry = {
+  // the URL or CDN your js assets are served from
   publicUrl: 'https://your.awesome.site',
+  // the sentry install you're using, https://sentry.io for hosted accounts
   sentryUrl: 'https://sentry.your.awesome.site',
   sentryOrganizationSlug: 'AwesomeOrg',
   sentryProjectSlug: 'AwesomeProject',
-  sentryApiKey: 'awesomeApiKey'
+
+  // One of:
+  sentryApiKey: 'awesomeApiKey',
+  // or
+  sentryBearerApiKey: 'awesomeApiKey'
 }
 ```
 - Integrate [raven-js][2] in your page
 
-Install [ember-cli-sentry](https://github.com/damiencaselli/ember-cli-sentry) but import the raven service from `ember-cli-deploy-sentry/service/raven`,
+Install [ember-cli-sentry](https://github.com/damiencaselli/ember-cli-sentry) but import the raven service from `ember-cli-deploy-sentry/services/raven`,
 which will automatically handle setting up the release version for you. Sentry needs this to find the correct sourcemap for an error that occurs.
 
 If you don't want to use `ember-cli-sentry` but set [raven-js][2] up manually see [Manual integration with raven-js](#manual-integration-with-raven-js).
@@ -85,7 +90,7 @@ For detailed information on how configuration of plugins works, please refer to
 
 ### publicUrl
 
-The public url to the root of your website.
+The public url to the root of where your assets are stored. For instance, if your assets are stored on Cloudfront, it would be `https://xxxx.cloudfront.net`.
 
 *Required*
 
@@ -110,9 +115,11 @@ You can specify this in project settings in sentry.
 
 *Required*
 
-### sentryApiKey
+### sentryApiKey _or_ sentryBearerApiKey
 
-An api key you can create in your organization settings. Make sure it has the `project:write` privilege.
+Either an HTTP Basic Auth username, or a bearer token. If you are uploading to the current Sentry API, use the latter. Use the former if you are using an older API.
+
+You can create the api key in your organization settings. Make sure it has the `project:write` privilege.
 
 *Required*
 
@@ -122,26 +129,6 @@ The root directory that all files matching the `filePattern` will be uploaded fr
 
 *Default:* `context.distDir`
 
-### didDeployMessage
-
-A message that will be displayed after the distDir has been copied to destDir.
-
-*Default:*
-
-```javascript
-      didDeployMessage: function(context){
-      return "Uploaded sourcemaps to sentry release: "
-        + this.readConfig('sentryUrl')
-        + '/'
-        + this.readConfig('sentryOrganizationSlug')
-        + '/'
-        + this.readConfig('sentryProjectSlug')
-        + '/releases/'
-        + this.readConfig('revisionKey')
-        + '/';
-    }
-```
-
 ### filePattern
 
 `minimatch` expression that is used to determine which files should be uploaded from the `distDir`.
@@ -151,18 +138,45 @@ A message that will be displayed after the distDir has been copied to destDir.
 ### revisionKey
 
 The revision string that is used to create releases in sentry.
+
+*Default:*
 ```javascript
   revisionKey: function(context) {
     return context.revisionData && context.revisionData.revisionKey;
   }
 ```
 
+### revisionCommits
+
+An array of revision commits allows us to associate commits with this Sentry release. See the [Sentry docs here](https://docs.sentry.io/workflow/releases/?platform=browser#using-the-api).
+
+*Default:*
+```javascript
+  revisionCommits: undefined
+```
+
+*Examples:*
+```javascript
+  revisionCommits: function(context) {
+    return [{
+      repository:"owner-name/repo-name", // required
+      id:"2da95dfb052f477380608d59d32b4ab9" // required
+    }]
+  }
+```
+
 ### enableRevisionTagging
 
 Enable adding a meta tag with the current revisionKey into the head of your `index.html`.
 
 *Default* true
 
+### replaceFiles
+
+At deploy-time, the plugin will check your Sentry instance for an existing release under the current `revisionKey`. If a release is found and this is set to `true`, all existing files for the matching release will be deleted before the current build's files are uploaded to Sentry. If this is set to `false`, the files on Sentry will remain untouched and the just-built files will not be uploaded. 
+
+*Default* true
+
 ## Prerequisites
 
 The following properties are expected to be present on the deployment `context` object:
@@ -183,7 +197,7 @@ When you setup [raven-js][2] you can retrieve it like this:
 
 ```javascript
 Raven.config({
-    release: $("meta[name='sentry:revision']").attr('content')
+    release: document.querySelector("meta[name='sentry:revision']").content
 });
 ```
 

addon/services/raven.js

@@ -1,10 +1,11 @@
+import Ember from 'ember';
 import RavenService from 'ember-cli-sentry/services/raven';
 
 export default RavenService.extend({
     releaseMetaName: 'sentry:revision',
-    release: Ember.computed({
+    release: Ember.computed('releaseMetaName', {
         get: function() {
-            return $("meta[name='revision']").attr('content');
+            return document.querySelector(`meta[name='${this.get('releaseMetaName')}']`).content;
         }
     })
 });

app/services/raven.js

@@ -0,0 +1,3 @@
+import RavenService from 'ember-cli-deply-sentry/services/raven';
+
+export default RavenService;