docs: mention that debug option is CLI only

README.md

@@ -1,8 +1,8 @@
 <h1 align="center" style="border-bottom: none;">📦🚀 semantic-release</h1>
 <h3 align="center">Fully automated version management and package publishing</h3>
 <p align="center">
-  <a href="https://gitter.im/semantic-release/semantic-release">
-    <img alt="Gitter" src="https://badges.gitter.im/semantic-release/semantic-release.svg">
+  <a href="https://spectrum.chat/semantic-release">
+    <img alt="Join the community on Spectrum" src="https://withspectrum.github.io/badge/badge.svg">
   </a>
   <a href="https://travis-ci.org/semantic-release/semantic-release">
     <img alt="Travis" src="https://img.shields.io/travis/semantic-release/semantic-release/master.svg">
@@ -124,7 +124,7 @@ After running the tests, the command `semantic-release` will execute the followi
 ## Get help
 
 - [Stack Overflow](https://stackoverflow.com/questions/tagged/semantic-release)
-- [Gitter chat](https://gitter.im/semantic-release/semantic-release)
+- [Spectrum community](https://spectrum.chat/semantic-release)
 - [Twitter](https://twitter.com/SemanticRelease)
 
 ## Badge

cli.js

@@ -47,11 +47,6 @@ Usage:
       return 0;
     }
 
-    // Set the `noCi` options as yargs sets the `ci` options instead (because arg starts with `--no`)
-    if (opts.ci === false) {
-      opts.noCi = true;
-    }
-
     if (opts.debug) {
       // Debug must be enabled before other requires in order to work
       require('debug').enable('semantic-release:*');

docs/extending/plugins-list.md

@@ -26,12 +26,16 @@
 - [@semantic-release/exec](https://github.com/semantic-release/exec)
   - `verifyConditions`: Execute a shell command to verify if the release should happen
   - `analyzeCommits`: Execute a shell command to determine the type of release
-  - `verifyRelease`: Execute a shell command to verifying a release that was determined before and is about to be published.
+  - `verifyRelease`: Execute a shell command to verifying a release that was determined before and is about to be published
   - `generateNotes`: Execute a shell command to generate the release note
   - `prepare`: Execute a shell command to prepare the release
   - `publish`: Execute a shell command to publish the release
   - `success`: Execute a shell command to notify of a new release
   - `fail`: Execute a shell command to notify of a failed release
+- [@semantic-release/apm](https://github.com/semantic-release/apm)
+  - `verifyConditions`: Verify the presence of the `ATOM_ACCESS_TOKEN` environment variable and the [`apm`](https://github.com/atom/apm) CLI
+  - `prepare`: Update the `package.json` version with [`npm version`](https://docs.npmjs.com/cli/version)
+  - `publish`: Publish the [Atom package](https://flight-manual.atom.io/hacking-atom/sections/publishing)
 
 ## Community plugins
 
@@ -39,10 +43,10 @@
 
 - [semantic-release-docker](https://github.com/felixfbecker/semantic-release-docker)
   - `verifyConditions`: Verify that all needed configuration is present and login to the Docker registry.
-  - `publish`: Tag the image specified by `name` with the new version, push it to Docker Hub and update the latest tag.
+  - `publish`: Tag the image specified by `name` with the new version, push it to Docker Hub and update the latest tag
 - [semantic-release-gcr](https://github.com/carlos-cubas/semantic-release-gcr)
-  - `verifyConditions`: Verify that all needed configuration is present and login to the Docker registry.
-  - `publish`: Tag the image specified by `name` with the new version, push it to Docker Hub and update the latest tag.
+  - `verifyConditions`: Verify that all needed configuration is present and login to the Docker registry
+  - `publish`: Tag the image specified by `name` with the new version, push it to Docker Hub and update the latest tag
 - [semantic-release-vsce](https://github.com/raix/semantic-release-vsce)
   - `verifyConditions`: Verify the presence and the validity of the vsce authentication and release configuration
   - `prepare`: Create a `.vsix` for distribution
@@ -51,14 +55,19 @@
   - `verifyConditions`: Check the dependencies format against a regexp before a release
 - [semantic-release-chrome](https://github.com/GabrielDuarteM/semantic-release-chrome)
   - `verifyConditions`: Verify the presence of the authentication (set via environment variables)
-  - `prepare`: Write the correct version to the manifest.json and creates a zip file of the whole dist folder
+  - `prepare`: Write the correct version to the `manifest.json` and creates a zip file of the whole dist folder
   - `publish`: Uploads the generated zip file to the webstore, and publish the item
 - [semantic-release-firefox](https://github.com/felixfbecker/semantic-release-firefox)
   - `verifyConditions`: Verify the presence of the authentication (set via environment variables)
-  - `prepare`: Write the correct version to the manifest.json,   creates a xpi file of the dist folder and a zip of the sources
+  - `prepare`: Write the correct version to the `manifest.json`, creates a `xpi` file of the dist folder and a zip of the sources
   - `publish`: Submit the generated archives to the webstore for review, and publish the item including release notes
 - [semantic-release-gerrit](https://github.com/pascalMN/semantic-release-gerrit)
   - `generateNotes`: Generate release notes with Gerrit reviews URL
 - [semantic-release-expo](https://github.com/bycedric/semantic-release-expo)
   - `verifyConditions`: Verify Expo manifest(s) are readable and valid.
   - `prepare`: Update version, ios build number and android version code in the Expo manifest(s).
+- [maven-semantic-release](https://github.com/conveyal/maven-semantic-release)
+  - `verifyConditions`: Verifies that the `pom.xml` file and other files exist and are setup to allow releases
+  - `verifyRelease`: Checks and warns (does not error by default) if the version numbers found on maven central and within the Git project differ by quite a bit
+  - `prepare`: Changes the version number in the `pom.xml` (or all `pom.xml` files in maven projects with multiple `pom.xml` files) and optionally creates a commit with this version number and pushes it to `master`
+  - `publish`: Runs `mvn deploy` to deploy to maven central and optionally will update to next snapshot version and merge changes to development branch

docs/usage/configuration.md

@@ -133,6 +133,8 @@ CLI argument: `--debug`
 
 Output debugging information. This can also be enabled by setting the `DEBUG` environment variable to `semantic-release:*`.
 
+**Note**: The `debug` is used only supported via CLI argument. To enable debug mode from the [JS API](../developer-guide/js-api.md#javascript-api) use `require('debug').enable('semantic-release:*')`.
+
 ## Git environment variables
 
 | Variable              | Description                                                                                                                                                                                                                    | Default                              |

index.js

@@ -107,7 +107,7 @@ async function run(context, plugins) {
   } else {
     // Create the tag before calling the publish plugins as some require the tag to exists
     await tag(nextRelease.gitTag, {cwd, env});
-    await push(options.repositoryUrl, options.branch, {cwd, env});
+    await push(options.repositoryUrl, {cwd, env});
     logger.success(`Created tag ${nextRelease.gitTag}`);
   }
 

lib/get-config.js

@@ -27,6 +27,9 @@ module.exports = async (context, opts) => {
 
   // Merge config file options and CLI/API options
   let options = {...config, ...opts};
+  if (options.ci === false) {
+    options.noCi = true;
+  }
   const pluginsPath = {};
   let extendPaths;
   ({extends: extendPaths, ...options} = options);

lib/git.js

@@ -143,12 +143,11 @@ async function tag(tagName, execaOpts) {
  * Push to the remote repository.
  *
  * @param {String} repositoryUrl The remote repository URL.
- * @param {String} branch The branch to push.
  * @param {Object} [execaOpts] Options to pass to `execa`.
  *
  * @throws {Error} if the push failed.
  */
-async function push(repositoryUrl, branch, execaOpts) {
+async function push(repositoryUrl, execaOpts) {
   await execa('git', ['push', '--tags', repositoryUrl], execaOpts);
 }
 

package.json

@@ -60,10 +60,10 @@
     "js-yaml": "^3.10.0",
     "mockserver-client": "^5.1.1",
     "nock": "^10.0.0",
-    "nyc": "^12.0.1",
+    "nyc": "^13.1.0",
     "p-retry": "^2.0.0",
     "proxyquire": "^2.0.0",
-    "sinon": "^6.0.0",
+    "sinon": "^7.1.1",
     "stream-buffers": "^3.0.2",
     "tempy": "^0.2.1",
     "xo": "^0.23.0"

test/cli.test.js

@@ -163,18 +163,6 @@ test.serial('Do not set properties in option for which arg is not in command lin
   t.false('e' in run.args[0][0]);
 });
 
-test.serial('Set "noCi" options to "true" with "--no-ci"', async t => {
-  const run = stub().resolves(true);
-  const argv = ['', '', '--no-ci'];
-  const cli = requireNoCache('../cli', {'.': run, process: {...process, argv}});
-
-  const exitCode = await cli();
-
-  t.is(run.args[0][0].noCi, true);
-
-  t.is(exitCode, 0);
-});
-
 test.serial('Display help', async t => {
   const run = stub().resolves(true);
   const argv = ['', '', '--help'];

test/get-config.test.js

@@ -67,6 +67,18 @@ test('Default values, reading repositoryUrl (http url) from package.json if not
   t.is(result.tagFormat, `v\${version}`);
 });
 
+test('Convert "ci" option to "noCi"', async t => {
+  const pkg = {repository: 'https://host.null/owner/module.git', release: {ci: false}};
+  // Create a git repository, set the current working directory at the root of the repo
+  const {cwd} = await gitRepo();
+  // Create package.json in repository root
+  await outputJson(path.resolve(cwd, 'package.json'), pkg);
+
+  const {options: result} = await t.context.getConfig({cwd});
+
+  t.is(result.noCi, true);
+});
+
 test('Read options from package.json', async t => {
   // Create a git repository, set the current working directory at the root of the repo
   const {cwd} = await gitRepo();

test/git.test.js

@@ -157,7 +157,7 @@ test('Push tag to remote repository', async t => {
   const commits = await gitCommits(['Test commit'], {cwd});
 
   await tag('tag_name', {cwd});
-  await push(repositoryUrl, 'master', {cwd});
+  await push(repositoryUrl, {cwd});
 
   t.is(await gitRemoteTagHead(repositoryUrl, 'tag_name', {cwd}), commits[0].hash);
 });
@@ -171,7 +171,7 @@ test('Push tag to remote repository with remote branch ahaed', async t => {
   await gitPush('origin', 'master', {cwd: tmpRepo});
 
   await tag('tag_name', {cwd});
-  await push(repositoryUrl, 'master', {cwd});
+  await push(repositoryUrl, {cwd});
 
   t.is(await gitRemoteTagHead(repositoryUrl, 'tag_name', {cwd}), commits[0].hash);
 });

test/helpers/mock-github.js

@@ -1,16 +0,0 @@
-import nock from 'nock';
-
-/**
- * Retun a `nock` object setup to respond to a github authentication request. Other expectation and responses can be chained.
- *
- * @param {String} [githubToken='GH_TOKEN'] The github token to return in the authentication response.
- * @param {String} [githubUrl='https://api.github.com'] The url on which to intercept http requests.
- * @return {Object} A `nock` object ready to respond to a github authentication request.
- */
-export default function authenticate({
-  githubToken = 'GH_TOKEN',
-  githubUrl = 'https://api.github.com',
-  githubApiPathPrefix = '',
-} = {}) {
-  return nock(`${githubUrl}/${githubApiPathPrefix}`, {reqheaders: {Authorization: `token ${githubToken}`}});
-}