feat: new function signature

BREAKING CHANGE: old one doesn't work anymore

Author: boennemann

src/index.js

@@ -2,15 +2,13 @@ const { unlinkSync } = require('fs')
 
 const SRError = require('@semantic-release/error')
 
-module.exports = function (options, pkg, argv, env, cb) {
+module.exports = function (pluginConfig, {env, options}, cb) {
   if (env.TRAVIS !== 'true') return cb(new SRError('Not running on Travis', 'ENOTRAVIS'))
 
   if (env.hasOwnProperty('TRAVIS_PULL_REQUEST') && env.TRAVIS_PULL_REQUEST !== 'false') return cb(new SRError('Not publishing from pull requests', 'EPULLREQUEST'))
   if (env.TRAVIS_TAG) return cb(new SRError('Not publishing from tags', 'EGITTAG'))
 
-  const branch = (pkg.release || {}).branch || 'master'
-
-  if (branch !== env.TRAVIS_BRANCH) return cb(new SRError(`Branch is not ${branch}`, 'EBRANCHMISMATCH'))
+  if (options.branch !== env.TRAVIS_BRANCH) return cb(new SRError(`Branch is not ${options.branch}`, 'EBRANCHMISMATCH'))
 
   if (env.BUILD_MINION === 'YES') return cb(new SRError('Not publishing from minion', 'ENOBUILDLEADER'))
 

test/specs/index.js

@@ -7,17 +7,19 @@ test('raise errors in travis environment', (t) => {
   t.test('only runs on travis', (tt) => {
     tt.plan(2)
 
-    condition({}, {}, {}, {}, (err) => {
+    condition({}, {env: {}}, (err) => {
       tt.ok(err instanceof SRError)
       tt.is(err.code, 'ENOTRAVIS')
     })
   })
 
   t.test('not running on pull requests', (tt) => {
     tt.plan(2)
-    condition({}, {}, {}, {
-      TRAVIS: 'true',
-      TRAVIS_PULL_REQUEST: '105'
+    condition({}, {
+      env: {
+        TRAVIS: 'true',
+        TRAVIS_PULL_REQUEST: '105'
+      }
     }, (err) => {
       tt.ok(err instanceof SRError)
       tt.is(err.code, 'EPULLREQUEST')
@@ -26,10 +28,12 @@ test('raise errors in travis environment', (t) => {
 
   t.test('not running on tags', (tt) => {
     tt.plan(2)
-    condition({}, {}, {}, {
-      TRAVIS: 'true',
-      TRAVIS_PULL_REQUEST: 'false',
-      TRAVIS_TAG: 'v1.0.0'
+    condition({}, {
+      env: {
+        TRAVIS: 'true',
+        TRAVIS_PULL_REQUEST: 'false',
+        TRAVIS_TAG: 'v1.0.0'
+      }
     }, (err) => {
       tt.ok(err instanceof SRError)
       tt.is(err.code, 'EGITTAG')
@@ -39,28 +43,39 @@ test('raise errors in travis environment', (t) => {
   t.test('only running on specified branch', (tt) => {
     tt.plan(5)
 
-    condition({}, {}, {}, {
-      TRAVIS: 'true',
-      TRAVIS_BRANCH: 'master'
+    condition({}, {
+      env: {
+        TRAVIS: 'true',
+        TRAVIS_BRANCH: 'master'
+      },
+      options: {
+        branch: 'master'
+      }
     }, (err) => {
       tt.is(err, null)
     })
 
-    condition({}, {}, {}, {
-      TRAVIS: 'true',
-      TRAVIS_BRANCH: 'notmaster'
+    condition({}, {
+      env: {
+        TRAVIS: 'true',
+        TRAVIS_BRANCH: 'notmaster'
+      },
+      options: {
+        branch: 'master'
+      }
     }, (err) => {
       tt.ok(err instanceof SRError)
       tt.is(err.code, 'EBRANCHMISMATCH')
     })
 
     condition({}, {
-      release: {
+      env: {
+        TRAVIS: 'true',
+        TRAVIS_BRANCH: 'master'
+      },
+      options: {
         branch: 'foo'
       }
-    }, {}, {
-      TRAVIS: 'true',
-      TRAVIS_BRANCH: 'master'
     }, (err) => {
       tt.ok(err instanceof SRError)
       tt.is(err.code, 'EBRANCHMISMATCH')
@@ -70,29 +85,44 @@ test('raise errors in travis environment', (t) => {
   t.test('supports travis_after_all', (tt) => {
     tt.plan(5)
 
-    condition({}, {}, {}, {
-      TRAVIS: 'true',
-      TRAVIS_BRANCH: 'master',
-      BUILD_LEADER: 'YES',
-      BUILD_AGGREGATE_STATUS: 'others_succeeded'
+    condition({}, {
+      env: {
+        TRAVIS: 'true',
+        TRAVIS_BRANCH: 'master',
+        BUILD_LEADER: 'YES',
+        BUILD_AGGREGATE_STATUS: 'others_succeeded'
+      },
+      options: {
+        branch: 'master'
+      }
     }, (err) => {
       tt.is(err, null)
     })
 
-    condition({}, {}, {}, {
-      TRAVIS: 'true',
-      TRAVIS_BRANCH: 'master',
-      BUILD_MINION: 'YES'
+    condition({}, {
+      env: {
+        TRAVIS: 'true',
+        TRAVIS_BRANCH: 'master',
+        BUILD_MINION: 'YES'
+      },
+      options: {
+        branch: 'master'
+      }
     }, (err) => {
       tt.ok(err instanceof SRError)
       tt.is(err.code, 'ENOBUILDLEADER')
     })
 
-    condition({}, {}, {}, {
-      TRAVIS: 'true',
-      TRAVIS_BRANCH: 'master',
-      BUILD_LEADER: 'YES',
-      BUILD_AGGREGATE_STATUS: 'others_failed'
+    condition({}, {
+      env: {
+        TRAVIS: 'true',
+        TRAVIS_BRANCH: 'master',
+        BUILD_LEADER: 'YES',
+        BUILD_AGGREGATE_STATUS: 'others_failed'
+      },
+      options: {
+        branch: 'master'
+      }
     }, (err) => {
       tt.ok(err instanceof SRError)
       tt.is(err.code, 'EOTHERSFAILED')