ref: Allow for nested setCommits (#142)

* nest setCommits options for clarity

* Modify setCommits tests to support nesting

* Rename setCommits title & add required for repo++

* Make room for old implementation of setCommits

This makes it possible to use both nested and non-nested setOptions

* Add table section for setCommits

* add `options.` prefix on header

* Add new tests for nested and flat setCommits

Co-authored-by: Kamil Ogórek <kamil.ogorek@gmail.com>

* Fix linter issues

Author: Sølve Tornøe

README.md

@@ -59,8 +59,8 @@ Also, check the [example](example) directory.
 
 #### Options
 
-Option | Type | Required | Description |
--------|------|----------|-------------
+| Option | Type | Required | Description |
+---------|------|----------|-------------
 release | `string` | optional | unique name of a release, must be a `string`, should uniquely identify your release, defaults to `sentry-cli releases propose-version` command which should always return the correct version (**requires access to `git` CLI and root directory to be a valid repository**).
 include | `string`/`array` | required | one or more paths that Sentry CLI should scan recursively for sources. It will upload all `.map` files and match associated `.js` files |
 entries | `array`/`RegExp`/`function(key: string): bool` | optional | a filter for entry points that should be processed. By default, the release will be injected into all entry points. |
@@ -79,13 +79,17 @@ entries | `array`/`RegExp`/`function(key: string): bool` | optional | a filter f
 | debug | `boolean` | optional | print some useful debug information |
 | silent | `boolean` | optional | if `true`, all logs are suppressed (useful for `--json` option) |
 | errorHandler | `function(err: Error, invokeErr: function(): void): void` | optional | when Cli error occurs, plugin calls this function. webpack compilation failure can be chosen by calling `invokeErr` callback or not. default `(err, invokeErr) => { invokeErr()}` |
+| setCommits | `Object` | optional | Adds commits to sentry - [see own table below](#setCommits) for more details |
 
 
-set-commits options:
-* `commit [optional]` - `string`, the current (last) commit in the release
-* `previousCommit [optional]` - `string`, the commit before the beginning of this release (in other words, the last commit of the previous release). If omitted, this will default to the last commit of the previous release in Sentry. If there was no previous release, the last 10 commits will be used
-* `repo [optional]` - `string`, the full repo name as defined in Sentry
-* `auto [optional]` - `boolean`, automatically choose the associated commit (uses the current commit). Overrides other options
+#### <a name="setCommits"></a>options.setCommits:
+
+| Option | Type | Required | Description |
+---------|------|----------|-------------
+| repo | `string` | required | the full git repo name as defined in Sentry |
+| commit | `string` | optional/required | the current (last) commit in the release |
+| previousCommit | `string` | optional | the commit before the beginning of this release (in other words, the last commit of the previous release). If omitted, this will default to the last commit of the previous release in Sentry. If there was no previous release, the last 10 commits will be used |
+| auto | `boolean` | optional/required | automatically choose the associated commit (uses the current commit). Overrides other options |
 
 You can find more information about these options in our official docs:
 https://docs.sentry.io/cli/releases/#sentry-cli-sourcemaps

src/__tests__/index.spec.js

@@ -228,14 +228,14 @@ describe('afterEmitHook', () => {
     });
   });
 
-  test('test setCommits with commits range', done => {
+  test('test setCommits with flat options', done => {
     const sentryCliPlugin = new SentryCliPlugin({
       include: 'src',
       release: '42',
       commit: '4d8656426ca13eab19581499da93408e30fdd9ef',
       previousCommit: 'b6b0e11e74fd55836d3299cef88531b2a34c2514',
       repo: 'group / repo',
-      // auto,
+      auto: false,
     });
 
     sentryCliPlugin.apply(compiler);
@@ -245,26 +245,33 @@ describe('afterEmitHook', () => {
         repo: 'group / repo',
         commit: '4d8656426ca13eab19581499da93408e30fdd9ef',
         previousCommit: 'b6b0e11e74fd55836d3299cef88531b2a34c2514',
+        auto: false,
       });
       expect(compilationDoneCallback).toBeCalled();
       done();
     });
   });
 
-  test('test setCommits with auto option', done => {
+  test('test setCommits with grouped options', done => {
     const sentryCliPlugin = new SentryCliPlugin({
       include: 'src',
       release: '42',
-      repo: 'group / repo',
-      auto: true,
+      setCommits: {
+        commit: '4d8656426ca13eab19581499da93408e30fdd9ef',
+        previousCommit: 'b6b0e11e74fd55836d3299cef88531b2a34c2514',
+        repo: 'group / repo',
+        auto: false,
+      },
     });
 
     sentryCliPlugin.apply(compiler);
 
     setImmediate(() => {
       expect(mockCli.releases.setCommits).toBeCalledWith('42', {
         repo: 'group / repo',
-        auto: true,
+        commit: '4d8656426ca13eab19581499da93408e30fdd9ef',
+        previousCommit: 'b6b0e11e74fd55836d3299cef88531b2a34c2514',
+        auto: false,
       });
       expect(compilationDoneCallback).toBeCalled();
       done();

src/index.js

@@ -322,7 +322,8 @@ class SentryCliPlugin {
       })
       .then(() => this.cli.releases.uploadSourceMaps(release, this.options))
       .then(() => {
-        const { commit, previousCommit, repo, auto } = this.options;
+        const { commit, previousCommit, repo, auto } =
+          this.options.setCommits || this.options;
 
         if (repo && (commit || auto)) {
           this.cli.releases.setCommits(release, {