feat: allow to release from local machine

Include npm version badges for both `@latest` and `@next` dist-tag

README.md

@@ -1,21 +1,19 @@
 # :package::rocket: semantic-release
 
-**fully automated package publishing**
+**Fully automated package publishing**
 
 > **Trust us, this will change your workflow for the better.**
 
 > – [egghead.io](https://egghead.io/lessons/javascript-how-to-write-a-javascript-library-automating-releases-with-semantic-release)
 
-[![Join the chat at https://gitter.im/semantic-release/semantic-release](https://badges.gitter.im/Join%20Chat.svg)](https://gitter.im/semantic-release/semantic-release?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge&utm_content=badge)
-[![npm](https://img.shields.io/npm/v/semantic-release.svg)](https://www.npmjs.com/package/semantic-release)
-[![Greenkeeper badge](https://badges.greenkeeper.io/semantic-release/semantic-release.svg)](https://greenkeeper.io/)
-[![license](https://img.shields.io/github/license/semantic-release/semantic-release.svg)](https://github.com/semantic-release/semantic-release/blob/master/LICENSE)
-[![styled with prettier](https://img.shields.io/badge/styled_with-prettier-ff69b4.svg)](https://github.com/prettier/prettier)
-[![semantic-release](https://img.shields.io/badge/%20%20%F0%9F%93%A6%F0%9F%9A%80-semantic--release-e10079.svg)](https://github.com/semantic-release/semantic-release)
-[![Commitizen friendly](https://img.shields.io/badge/commitizen-friendly-brightgreen.svg)](http://commitizen.github.io/cz-cli/)
-
+[![Gitter](https://badges.gitter.im/semantic-release/semantic-release.svg)](https://gitter.im/semantic-release/semantic-release?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge)
 [![Travis](https://img.shields.io/travis/semantic-release/semantic-release/caribou.svg)](https://travis-ci.org/semantic-release/semantic-release)
 [![Codecov](https://img.shields.io/codecov/c/github/semantic-release/semantic-release/caribou.svg)](https://codecov.io/gh/semantic-release/semantic-release)
+[![Greenkeeper badge](https://badges.greenkeeper.io/semantic-release/semantic-release.svg)](https://greenkeeper.io/)
+[![semantic-release](https://img.shields.io/badge/%20%20%F0%9F%93%A6%F0%9F%9A%80-semantic--release-e10079.svg)](https://github.com/semantic-release/semantic-release)
+
+[![npm](https://img.shields.io/npm/v/semantic-release/latest.svg)](https://www.npmjs.com/package/semantic-release)
+[![npm](https://img.shields.io/npm/v/semantic-release/next.svg)](https://www.npmjs.com/package/semantic-release)
 
 Out of the box this is just about _commit-messages_, but you can do so much more.
 
@@ -170,6 +168,7 @@ semantic-release
 These options are currently available:
 - `branch`: The branch on which releases should happen. Default: `'master'`
 - `repositoryUrl`: The git repository URL. Default: `repository` property in `package.json` or git origin url. Any valid git url format is supported (See [Git protocols](https://git-scm.com/book/en/v2/Git-on-the-Server-The-Protocols)). If the [Github plugin](https://github.com/semantic-release/github) is used the URL must be a valid Github URL that include the `owner`, the `repository` name and the `host`. The Github shorthand URL is not supported.
+- `no-ci`: Skip Continuous Integration environment verifications, allowing to make releases from a local machine
 - `dry-run`: Dry-run mode, skip publishing, print next version and release notes
 - `extends`: Array of module or files path containing a shareable configuration. Options defined via CLI or in the `release` property will take precedence over the one defined in a shareable configuration.
 - `debug`: Output debugging information
@@ -271,7 +270,8 @@ If you run `npm run semantic-release` locally a dry run gets performed, which lo
 
 ### Can I run this on my own machine rather than on a CI server?
 
-Of course you can, but this doesn’t necessarily mean you should. Running your tests on an independent machine before releasing software is a crucial part of this workflow. Also it is a pain to set this up locally, with tokens lying around and everything. That said, you can run the scripts with `--debug=false` explicitly. You have to export `GH_TOKEN=<your_token>` and `NPM_TOKEN=<your_other_token>`.
+Yes, you can by explicitly setting the [`--no-ci` CLI option](#options), but this doesn’t necessarily mean you should. Running your tests on an independent machine before releasing software is a crucial part of this workflow.
+You will need to set all necessary authentication token (like `GH_TOKEN` and `NPM_TOKEN`) on your local machine.
 
 ### Can I manually trigger the release of a specific version?
 

cli.js

@@ -27,6 +27,10 @@ module.exports = async () => {
     )
     .option('--generate-notes <path>', 'Path or package name for the generateNotes plugin')
     .option('--publish <paths>', 'Comma separated list of paths or packages name for the publish plugin(s)', list)
+    .option(
+      '--no-ci',
+      'Skip Continuous Integration environment verifications, allowing to make releases from a local machine'
+    )
     .option('--debug', 'Output debugging information')
     .option(
       '-d, --dry-run',

index.js

@@ -10,13 +10,13 @@ const {gitHead: getGitHead, isGitRepo} = require('./lib/git');
 module.exports = async opts => {
   const {isCi, branch, isPr} = envCi();
 
-  if (!isCi && !opts.dryRun) {
+  if (!isCi && !opts.dryRun && !opts.noCi) {
     logger.log('This run was not triggered in a known CI environment, running in dry-run mode.');
     opts.dryRun = true;
   }
 
-  if (isCi && isPr) {
-    logger.log('This run was triggered by a pull request and therefore a new version won’t be published.');
+  if (isCi && isPr && !opts.noCi) {
+    logger.log("This run was triggered by a pull request and therefore a new version won't be published.");
     return;
   }
 

package.json

@@ -17,7 +17,7 @@
   "dependencies": {
     "@semantic-release/commit-analyzer": "^5.0.0",
     "@semantic-release/error": "^2.1.0",
-    "@semantic-release/github": "^3.0.0",
+    "@semantic-release/github": "^3.0.1",
     "@semantic-release/npm": "^2.0.0",
     "@semantic-release/release-notes-generator": "^6.0.0",
     "chalk": "^2.3.0",

test/index.test.js

@@ -209,7 +209,7 @@ test.serial('Dry-run skips publish', async t => {
   t.is(publish.callCount, 0);
 });
 
-test.serial('Force a dry-run if not on a CI', async t => {
+test.serial('Force a dry-run if not on a CI and ignore "noCi" is not explicitly set', async t => {
   // Create a git repository, set the current working directory at the root of the repo
   await gitRepo();
   // Add commits to the master branch
@@ -257,6 +257,58 @@ test.serial('Force a dry-run if not on a CI', async t => {
   t.is(publish.callCount, 0);
 });
 
+test.serial('Allow local releases with "noCi" option', async t => {
+  // Create a git repository, set the current working directory at the root of the repo
+  await gitRepo();
+  // Add commits to the master branch
+  let commits = await gitCommits(['First']);
+  // Create the tag corresponding to version 1.0.0
+  await gitTagVersion('v1.0.0');
+  // Add new commits to the master branch
+  commits = (await gitCommits(['Second'])).concat(commits);
+
+  const lastRelease = {version: '1.0.0', gitHead: commits[commits.length - 1].hash, gitTag: 'v1.0.0'};
+  const nextRelease = {type: 'major', version: '2.0.0', gitHead: await getGitHead(), gitTag: 'v2.0.0'};
+  const notes = 'Release notes';
+
+  const verifyConditions = stub().resolves();
+  const getLastRelease = stub().resolves(lastRelease);
+  const analyzeCommits = stub().resolves(nextRelease.type);
+  const verifyRelease = stub().resolves();
+  const generateNotes = stub().resolves(notes);
+  const publish = stub().resolves();
+
+  const options = {
+    noCi: true,
+    branch: 'master',
+    repositoryUrl: 'git@hostname.com:owner/module.git',
+    verifyConditions,
+    getLastRelease,
+    analyzeCommits,
+    verifyRelease,
+    generateNotes,
+    publish,
+  };
+
+  const semanticRelease = proxyquire('..', {
+    './lib/logger': t.context.logger,
+    'env-ci': () => ({isCi: false, branch: 'master', isPr: true}),
+  });
+  t.truthy(await semanticRelease(options));
+
+  t.not(t.context.log.args[0][0], 'This run was not triggered in a known CI environment, running in dry-run mode.');
+  t.not(
+    t.context.log.args[0][0],
+    "This run was triggered by a pull request and therefore a new version won't be published."
+  );
+  t.is(verifyConditions.callCount, 1);
+  t.is(getLastRelease.callCount, 1);
+  t.is(analyzeCommits.callCount, 1);
+  t.is(verifyRelease.callCount, 1);
+  t.is(generateNotes.callCount, 1);
+  t.is(publish.callCount, 1);
+});
+
 test.serial('Accept "undefined" values for the "getLastRelease" and "generateNotes" plugins', async t => {
   // Create a git repository, set the current working directory at the root of the repo
   await gitRepo();
@@ -333,7 +385,7 @@ test.serial('Returns falsy value if triggered by a PR', async t => {
   t.falsy(await semanticRelease({repositoryUrl: 'git@hostname.com:owner/module.git'}));
   t.is(
     t.context.log.args[0][0],
-    'This run was triggered by a pull request and therefore a new version won’t be published.'
+    "This run was triggered by a pull request and therefore a new version won't be published."
   );
 });
 

test/integration.test.js

@@ -118,6 +118,11 @@ test.serial('Release patch, minor and major versions', async t => {
     {headers: [{name: 'Authorization', values: [`token ${env.GH_TOKEN}`]}]},
     {body: {permissions: {push: true}}, method: 'GET'}
   );
+  let getRefMock = await mockServer.mock(
+    `/repos/${owner}/${packageName}/git/refs/tags/v${version}`,
+    {},
+    {body: {}, statusCode: 404, method: 'GET'}
+  );
   let createRefMock = await mockServer.mock(
     `/repos/${owner}/${packageName}/git/refs`,
     {body: {ref: `refs/tags/v${version}`}, headers: [{name: 'Authorization', values: [`token ${env.GH_TOKEN}`]}]},
@@ -136,7 +141,7 @@ test.serial('Release patch, minor and major versions', async t => {
   await gitCommits(['feat: Initial commit']);
   t.log('$ semantic-release');
   ({stdout, code} = await execa(cli, [], {env}));
-  t.regex(stdout, new RegExp(`Published Github release: release-url/${version}`));
+  t.regex(stdout, new RegExp(`Published GitHub release: release-url/${version}`));
   t.regex(stdout, new RegExp(`Publishing version ${version} to npm registry`));
   t.is(code, 0);
 
@@ -153,6 +158,7 @@ test.serial('Release patch, minor and major versions', async t => {
   t.log(`+ released ${releasedVersion} with gitHead ${releasedGitHead}`);
 
   await mockServer.verify(verifyMock);
+  await mockServer.verify(getRefMock);
   await mockServer.verify(createRefMock);
   await mockServer.verify(createReleaseMock);
 
@@ -163,6 +169,11 @@ test.serial('Release patch, minor and major versions', async t => {
     {headers: [{name: 'Authorization', values: [`token ${env.GH_TOKEN}`]}]},
     {body: {permissions: {push: true}}, method: 'GET'}
   );
+  getRefMock = await mockServer.mock(
+    `/repos/${owner}/${packageName}/git/refs/tags/v${version}`,
+    {},
+    {body: {}, statusCode: 404, method: 'GET'}
+  );
   createRefMock = await mockServer.mock(
     `/repos/${owner}/${packageName}/git/refs`,
     {body: {ref: `refs/tags/v${version}`}, headers: [{name: 'Authorization', values: [`token ${env.GH_TOKEN}`]}]},
@@ -181,7 +192,7 @@ test.serial('Release patch, minor and major versions', async t => {
   await gitCommits(['fix: bar']);
   t.log('$ semantic-release');
   ({stdout, code} = await execa(cli, [], {env}));
-  t.regex(stdout, new RegExp(`Published Github release: release-url/${version}`));
+  t.regex(stdout, new RegExp(`Published GitHub release: release-url/${version}`));
   t.regex(stdout, new RegExp(`Publishing version ${version} to npm registry`));
   t.is(code, 0);
 
@@ -198,6 +209,7 @@ test.serial('Release patch, minor and major versions', async t => {
   t.log(`+ released ${releasedVersion} with gitHead ${releasedGitHead}`);
 
   await mockServer.verify(verifyMock);
+  await mockServer.verify(getRefMock);
   await mockServer.verify(createRefMock);
   await mockServer.verify(createReleaseMock);
 
@@ -208,6 +220,11 @@ test.serial('Release patch, minor and major versions', async t => {
     {headers: [{name: 'Authorization', values: [`token ${env.GH_TOKEN}`]}]},
     {body: {permissions: {push: true}}, method: 'GET'}
   );
+  getRefMock = await mockServer.mock(
+    `/repos/${owner}/${packageName}/git/refs/tags/v${version}`,
+    {},
+    {body: {}, statusCode: 404, method: 'GET'}
+  );
   createRefMock = await mockServer.mock(
     `/repos/${owner}/${packageName}/git/refs`,
     {body: {ref: `refs/tags/v${version}`}, headers: [{name: 'Authorization', values: [`token ${env.GH_TOKEN}`]}]},
@@ -226,7 +243,7 @@ test.serial('Release patch, minor and major versions', async t => {
   await gitCommits(['feat: baz']);
   t.log('$ semantic-release');
   ({stdout, code} = await execa(cli, [], {env}));
-  t.regex(stdout, new RegExp(`Published Github release: release-url/${version}`));
+  t.regex(stdout, new RegExp(`Published GitHub release: release-url/${version}`));
   t.regex(stdout, new RegExp(`Publishing version ${version} to npm registry`));
   t.is(code, 0);
 
@@ -243,6 +260,7 @@ test.serial('Release patch, minor and major versions', async t => {
   t.log(`+ released ${releasedVersion} with gitHead ${releasedGitHead}`);
 
   await mockServer.verify(verifyMock);
+  await mockServer.verify(getRefMock);
   await mockServer.verify(createRefMock);
   await mockServer.verify(createReleaseMock);
 
@@ -253,6 +271,11 @@ test.serial('Release patch, minor and major versions', async t => {
     {headers: [{name: 'Authorization', values: [`token ${env.GH_TOKEN}`]}]},
     {body: {permissions: {push: true}}, method: 'GET'}
   );
+  getRefMock = await mockServer.mock(
+    `/repos/${owner}/${packageName}/git/refs/tags/v${version}`,
+    {},
+    {body: {}, statusCode: 404, method: 'GET'}
+  );
   createRefMock = await mockServer.mock(
     `/repos/${owner}/${packageName}/git/refs`,
     {body: {ref: `refs/tags/v${version}`}, headers: [{name: 'Authorization', values: [`token ${env.GH_TOKEN}`]}]},
@@ -271,7 +294,7 @@ test.serial('Release patch, minor and major versions', async t => {
   await gitCommits(['feat: foo\n\n BREAKING CHANGE: bar']);
   t.log('$ semantic-release');
   ({stdout, code} = await execa(cli, [], {env}));
-  t.regex(stdout, new RegExp(`Published Github release: release-url/${version}`));
+  t.regex(stdout, new RegExp(`Published GitHub release: release-url/${version}`));
   t.regex(stdout, new RegExp(`Publishing version ${version} to npm registry`));
   t.is(code, 0);
 
@@ -288,6 +311,7 @@ test.serial('Release patch, minor and major versions', async t => {
   t.log(`+ released ${releasedVersion} with gitHead ${releasedGitHead}`);
 
   await mockServer.verify(verifyMock);
+  await mockServer.verify(getRefMock);
   await mockServer.verify(createRefMock);
   await mockServer.verify(createReleaseMock);
 });
@@ -319,6 +343,11 @@ test.serial('Release versions from a packed git repository, using tags to determ
     {body: {ref: `refs/tags/v${version}`}, headers: [{name: 'Authorization', values: [`token ${env.GH_TOKEN}`]}]},
     {body: {ref: `refs/tags/${version}`}}
   );
+  let getRefMock = await mockServer.mock(
+    `/repos/${owner}/${packageName}/git/refs/tags/v${version}`,
+    {},
+    {body: {}, statusCode: 404, method: 'GET'}
+  );
   let createReleaseMock = await mockServer.mock(
     `/repos/${owner}/${packageName}/releases`,
     {
@@ -333,7 +362,7 @@ test.serial('Release versions from a packed git repository, using tags to determ
   await gitPackRefs();
   t.log('$ semantic-release');
   let {stdout, code} = await execa(cli, [], {env});
-  t.regex(stdout, new RegExp(`Published Github release: release-url/${version}`));
+  t.regex(stdout, new RegExp(`Published GitHub release: release-url/${version}`));
   t.regex(stdout, new RegExp(`Publishing version ${version} to npm registry`));
   t.is(code, 0);
   // Verify package.json has been updated
@@ -343,6 +372,7 @@ test.serial('Release versions from a packed git repository, using tags to determ
   t.is(releasedVersion, version);
   t.log(`+ released ${releasedVersion}`);
   await mockServer.verify(verifyMock);
+  await mockServer.verify(getRefMock);
   await mockServer.verify(createRefMock);
   await mockServer.verify(createReleaseMock);
   // Create a tag version so the tag can be used later to determine the commit associated with the version
@@ -356,6 +386,11 @@ test.serial('Release versions from a packed git repository, using tags to determ
     {headers: [{name: 'Authorization', values: [`token ${env.GH_TOKEN}`]}]},
     {body: {permissions: {push: true}}, method: 'GET'}
   );
+  getRefMock = await mockServer.mock(
+    `/repos/${owner}/${packageName}/git/refs/tags/v${version}`,
+    {},
+    {body: {}, statusCode: 404, method: 'GET'}
+  );
   createRefMock = await mockServer.mock(
     `/repos/${owner}/${packageName}/git/refs`,
     {body: {ref: `refs/tags/v${version}`}, headers: [{name: 'Authorization', values: [`token ${env.GH_TOKEN}`]}]},
@@ -373,7 +408,7 @@ test.serial('Release versions from a packed git repository, using tags to determ
   await gitCommits(['fix: bar']);
   t.log('$ semantic-release');
   ({stdout, code} = await execa(cli, [], {env}));
-  t.regex(stdout, new RegExp(`Published Github release: release-url/${version}`));
+  t.regex(stdout, new RegExp(`Published GitHub release: release-url/${version}`));
   t.regex(stdout, new RegExp(`Publishing version ${version} to npm registry`));
   t.is(code, 0);
   // Verify package.json has been updated
@@ -384,6 +419,7 @@ test.serial('Release versions from a packed git repository, using tags to determ
   t.is(releasedVersion, version);
   t.log(`+ released ${releasedVersion}`);
   await mockServer.verify(verifyMock);
+  await mockServer.verify(getRefMock);
   await mockServer.verify(createRefMock);
   await mockServer.verify(createReleaseMock);
 });
@@ -467,6 +503,11 @@ test.serial('Create a tag as a recovery solution for "ENOTINHISTORY" error', asy
     {headers: [{name: 'Authorization', values: [`token ${env.GH_TOKEN}`]}]},
     {body: {permissions: {push: true}}, method: 'GET'}
   );
+  let getRefMock = await mockServer.mock(
+    `/repos/${owner}/${packageName}/git/refs/tags/v${version}`,
+    {},
+    {body: {}, statusCode: 404, method: 'GET'}
+  );
   let createRefMock = await mockServer.mock(
     `/repos/${owner}/${packageName}/git/refs`,
     {body: {ref: `refs/tags/v${version}`}, headers: [{name: 'Authorization', values: [`token ${env.GH_TOKEN}`]}]},
@@ -484,7 +525,7 @@ test.serial('Create a tag as a recovery solution for "ENOTINHISTORY" error', asy
   await gitCommits(['feat: Initial commit']);
   t.log('$ semantic-release');
   let {stderr, stdout, code} = await execa(cli, [], {env});
-  t.regex(stdout, new RegExp(`Published Github release: release-url/${version}`));
+  t.regex(stdout, new RegExp(`Published GitHub release: release-url/${version}`));
   t.regex(stdout, new RegExp(`Publishing version ${version} to npm registry`));
   t.is(code, 0);
   // Verify package.json has been updated
@@ -499,6 +540,7 @@ test.serial('Create a tag as a recovery solution for "ENOTINHISTORY" error', asy
   t.is(releasedVersion, version);
   t.log(`+ released ${releasedVersion}`);
   await mockServer.verify(verifyMock);
+  await mockServer.verify(getRefMock);
   await mockServer.verify(createRefMock);
   await mockServer.verify(createReleaseMock);
 
@@ -542,6 +584,11 @@ test.serial('Create a tag as a recovery solution for "ENOTINHISTORY" error', asy
     {headers: [{name: 'Authorization', values: [`token ${env.GH_TOKEN}`]}]},
     {body: {permissions: {push: true}}, method: 'GET'}
   );
+  getRefMock = await mockServer.mock(
+    `/repos/${owner}/${packageName}/git/refs/tags/v${version}`,
+    {},
+    {body: {}, statusCode: 404, method: 'GET'}
+  );
   createRefMock = await mockServer.mock(
     `/repos/${owner}/${packageName}/git/refs`,
     {body: {ref: `refs/tags/v${version}`}, headers: [{name: 'Authorization', values: [`token ${env.GH_TOKEN}`]}]},
@@ -558,7 +605,7 @@ test.serial('Create a tag as a recovery solution for "ENOTINHISTORY" error', asy
 
   t.log('$ semantic-release');
   ({stderr, stdout, code} = await execa(cli, [], {env}));
-  t.regex(stdout, new RegExp(`Published Github release: release-url/${version}`));
+  t.regex(stdout, new RegExp(`Published GitHub release: release-url/${version}`));
   t.regex(stdout, new RegExp(`Publishing version ${version} to npm registry`));
   t.is(code, 0);
   // Verify package.json has been updated
@@ -569,6 +616,7 @@ test.serial('Create a tag as a recovery solution for "ENOTINHISTORY" error', asy
   t.is(releasedVersion, version);
   t.log(`+ released ${releasedVersion}`);
   await mockServer.verify(verifyMock);
+  await mockServer.verify(getRefMock);
   await mockServer.verify(createRefMock);
   await mockServer.verify(createReleaseMock);
 });
@@ -668,6 +716,11 @@ test.serial('Run via JS API', async t => {
     {headers: [{name: 'Authorization', values: [`token ${env.GH_TOKEN}`]}]},
     {body: {permissions: {push: true}}, method: 'GET'}
   );
+  const getRefMock = await mockServer.mock(
+    `/repos/${owner}/${packageName}/git/refs/tags/v${version}`,
+    {},
+    {body: {}, statusCode: 404, method: 'GET'}
+  );
   const createRefMock = await mockServer.mock(
     `/repos/${owner}/${packageName}/git/refs`,
     {
@@ -704,6 +757,7 @@ test.serial('Run via JS API', async t => {
   t.log(`+ released ${releasedVersion} with gitHead ${releasedGitHead}`);
 
   await mockServer.verify(verifyMock);
+  await mockServer.verify(getRefMock);
   await mockServer.verify(createRefMock);
   await mockServer.verify(createReleaseMock);
 });