fix: match tag to tagFormat from the begining of the string

docs/resources.md

@@ -13,6 +13,7 @@
 ## Articles
 
 - [“Introduction to SemVer” - Irina Gebauer](https://blog.greenkeeper.io/introduction-to-semver-d272990c44f2)
+- ["Introduction to Semantic Release" - liv](https://blog.greenkeeper.io/introduction-to-semantic-release-33f73b117c8)
 
 ## Tutorials
 

docs/support/FAQ.md

@@ -57,7 +57,36 @@ To publish a non-Node package (without a `package.json`) you would need to:
 - Set **semantic-release** [options](../usage/configuration.md#options) via [CLI arguments or rc file](../usage/configuration.md#configuration)
 - Make sure your CI job executing the `semantic-release` command has access to [Node >= 8](#why-does-semantic-release-require-node-version--83) to execute the `semantic-release` command
 
-See the [CI configuration recipes](../usage/ci-configuration.md) for more details on specific CI environments.
+See the [CI configuration recipes](../recipes/README.md#ci-configurations) for more details on specific CI environments.
+
+In addition you will need to configure the **semantic-release** [plugins](../usage/plugins.md#plugins) to:
+- Disable the [`@semantic-release/npm`](https://github.com/semantic-release/npm) plugin
+- Define plugins for the [verifyConditions](../usage/plugins.md#verifyconditions-plugin), [prepare](../usage/plugins.md#prepare-plugin) and [publish](../usage/plugins.md#publish-plugin) steps to release on your package registry. The [`@semantic-release/exec`](https://github.com/semantic-release/exec) plugin is recommended for situation where a release can be done with a shell command.
+
+Here is a basic example to create [GitHub releases](https://help.github.com/articles/about-releases) and use shell command to publish:
+
+```json
+{
+  "verifyConditions": ["@semantic-release/github"],
+  "prepare": [
+    {
+      "path": "@semantic-release/exec",
+      "cmd": "set-version ${nextRelease.version}"
+    }
+  ],
+  "publish": [
+    "@semantic-release/github",
+    {
+      "path": "@semantic-release/exec",
+      "cmd": "publish-package"
+    }
+  ],
+}
+```
+
+**Note**: This is a theoretical example where the command `set-version` update the project version with the value passed as its first argument and `publish-package` publishes the package to a registry.
+
+See the [package managers and languages recipes](../recipes/README.md#package-managers-and-languages) for more details on specific project types.
 
 ## Can I use semantic-release with any CI service?
 
@@ -65,7 +94,7 @@ Yes, **semantic-release** can be used with any CI service, as long as it provide
 - A way to set [authentication](../usage/ci-configuration.md#authentication) via environment variables
 - A way to guarantee that the `semantic-release` command is [executed only after all the tests of all the jobs in the CI build pass](../usage/ci-configuration.md#run-semantic-release-only-after-all-tests-succeeded)
 
-See the [CI configuration recipes](../usage/ci-configuration.md) for more details on specific CI environments.
+See the [CI configuration recipes](../recipes/README.md#ci-configurations) for more details on specific CI environments.
 
 ## Can I run semantic-release on my local machine rather than on a CI server?
 

docs/usage/ci-configuration.md

@@ -20,7 +20,7 @@ See [CI configuration recipes](../recipes/README.md#ci-configurations) for more
 
 Alternatively the Git authentication can be set up via [SSH keys](../recipes/git-auth-ssh-keys.md).
 
-Most **semantic-release** [plugins](plugins.md) require to set up authentication in order to publish to a package manager registry. The default [npm](https://github.com/semantic-release/npm#environment-variables) and [github](https://github.com/semantic-release/github#environment-variables) plugins require the following environment variables:
+Most **semantic-release** [plugins](plugins.md) require setting up authentication in order to publish to a package manager registry. The default [npm](https://github.com/semantic-release/npm#environment-variables) and [github](https://github.com/semantic-release/github#environment-variables) plugins require the following environment variables:
 
 | Variable    | Description                                                                                                                                                                                                                                                                                                               |
 |-------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
@@ -35,7 +35,7 @@ See [CI configuration recipes](../recipes/README.md#ci-configurations) for more
 
 ## Automatic setup with `semantic-release-cli`
 
-[`semantic-release-cli`](https://github.com/semantic-release/cli) allow to easily [install](installation.md) **semantic-release** in your Node project and set up the CI configuration:
+[`semantic-release-cli`](https://github.com/semantic-release/cli) allows for easy [installation](installation.md) of **semantic-release** in your Node project as well as setting up the CI configuration:
 
 ```bash
 npm install -g semantic-release-cli

docs/usage/configuration.md

@@ -27,7 +27,7 @@ $ semantic-release
 
 **Note**: CLI arguments take precedence over options configured in the configuration file.
 
-**Note**: Plugins options cannot be defined via CLI arguments and must be defined in the configuration file.
+**Note**: Plugin options cannot be defined via CLI arguments and must be defined in the configuration file.
 
 ## Options
 
@@ -37,7 +37,7 @@ Type: `Array`, `String`
 
 CLI arguments: `-e`, `--extends`
 
-List of modules or file paths containing a [shareable configuration](shareable-configurations.md). If multiple shareable configuration are set, they will be imported in the order defined with each configuration option taking precedence over the options defined in a previous shareable configuration.
+List of modules or file paths containing a [shareable configuration](shareable-configurations.md). If multiple shareable configurations are set, they will be imported in the order defined with each configuration option taking precedence over the options defined in a previous shareable configuration.
 
 **Note**: Options defined via CLI arguments or in the configuration file will take precedence over the ones defined in any shareable configuration.
 
@@ -79,7 +79,7 @@ The [Git tag](https://git-scm.com/book/en/v2/Git-Basics-Tagging) format used by
 
 Type: `Boolean`
 
-Default: `false` if running in a CI environment, `false` otherwise
+Default: `false` if running in a CI environment, `true` otherwise
 
 CLI arguments: `-d`, `--dry-run`
 
@@ -93,7 +93,7 @@ Default: `false`
 
 CLI arguments: `--no-ci`
 
-Skip Continuous Integration environment verifications, allowing to make releases from a local machine.
+Skip Continuous Integration environment verifications. This allows for making releases from a local machine.
 
 ### debug
 
@@ -103,7 +103,7 @@ Default: `false`
 
 CLI argument: `--debug`
 
-Output debugging information. It can also be enabled by set the `DEBUG` environment variable to `semantic-release:*`.
+Output debugging information. It can also be enabled by setting the `DEBUG` environment variable to `semantic-release:*`.
 
 ### verifyConditions
 

docs/usage/shareable-configurations.md

@@ -1,5 +1,5 @@
 # Shareable configurations
 
-A sharable configuration is an [npm](https://www.npmjs.com/) package that exports a **semantic-release** configuration object. It allows to easily use the same configuration across several projects.
+A sharable configuration is an [npm](https://www.npmjs.com/) package that exports a **semantic-release** configuration object. It allows for use of the same configuration across several projects.
 
 The shareable configurations to use can be set with the [extends](configuration.md#extends) option.

index.js

@@ -11,8 +11,10 @@ const getNextVersion = require('./lib/get-next-version');
 const getCommits = require('./lib/get-commits');
 const getLastRelease = require('./lib/get-last-release');
 const {extractErrors} = require('./lib/utils');
+const getGitAuthUrl = require('./lib/get-git-auth-url');
 const logger = require('./lib/logger');
-const {unshallow, gitHead: getGitHead, tag, push} = require('./lib/git');
+const {unshallow, verifyAuth, gitHead: getGitHead, tag, push} = require('./lib/git');
+const getError = require('./lib/get-error');
 
 marked.setOptions({renderer: new TerminalRenderer()});
 
@@ -22,6 +24,10 @@ async function run(options, plugins) {
   if (!isCi && !options.dryRun && !options.noCi) {
     logger.log('This run was not triggered in a known CI environment, running in dry-run mode.');
     options.dryRun = true;
+  } else {
+    // When running on CI, prevent the `git` CLI to prompt for username/password. See #703.
+    process.env.GIT_ASKPASS = 'echo';
+    process.env.GIT_TERMINAL_PROMPT = 0;
   }
 
   if (isCi && isPr && !options.noCi) {
@@ -40,6 +46,11 @@ async function run(options, plugins) {
 
   await verify(options);
 
+  options.repositoryUrl = await getGitAuthUrl(options);
+  if (!await verifyAuth(options.repositoryUrl, options.branch)) {
+    throw getError('EGITNOPERMISSION', {options});
+  }
+
   logger.log('Run automated release from branch %s', options.branch);
 
   logger.log('Call plugin %s', 'verify-conditions');

lib/get-config.js

@@ -6,7 +6,6 @@ const debug = require('debug')('semantic-release:config');
 const {repoUrl} = require('./git');
 const PLUGINS_DEFINITIONS = require('./definitions/plugins');
 const plugins = require('./plugins');
-const getGitAuthUrl = require('./get-git-auth-url');
 
 module.exports = async (opts, logger) => {
   const {config} = (await cosmiconfig('release', {rcExtensions: true}).load(process.cwd())) || {};
@@ -51,8 +50,6 @@ module.exports = async (opts, logger) => {
     ...pickBy(options, option => !isUndefined(option) && !isNull(option)),
   };
 
-  options.repositoryUrl = await getGitAuthUrl(options);
-
   debug('options values: %O', options);
 
   return {options, plugins: await plugins(options, pluginsPath, logger)};

lib/get-git-auth-url.js

@@ -17,38 +17,36 @@ const GIT_TOKENS = ['GIT_CREDENTIALS', 'GH_TOKEN', 'GITHUB_TOKEN', 'GL_TOKEN', '
  * @return {String} The formatted Git repository URL.
  */
 module.exports = async ({repositoryUrl, branch}) => {
-  if (repositoryUrl) {
-    const info = hostedGitInfo.fromUrl(repositoryUrl, {noGitPlus: true});
+  const info = hostedGitInfo.fromUrl(repositoryUrl, {noGitPlus: true});
 
-    if (info && info.getDefaultRepresentation() === 'shortcut') {
-      // Expand shorthand URLs (such as `owner/repo` or `gitlab:owner/repo`)
-      repositoryUrl = info.https();
-    } else {
-      const {protocols} = gitUrlParse(repositoryUrl);
+  if (info && info.getDefaultRepresentation() === 'shortcut') {
+    // Expand shorthand URLs (such as `owner/repo` or `gitlab:owner/repo`)
+    repositoryUrl = info.https();
+  } else {
+    const {protocols} = gitUrlParse(repositoryUrl);
 
-      // Replace `git+https` and `git+http` with `https` or `http`
-      if (protocols.includes('http') || protocols.includes('https')) {
-        repositoryUrl = format({
-          ...parse(repositoryUrl),
-          ...{protocol: protocols.includes('https') ? 'https' : 'http'},
-        });
-      }
+    // Replace `git+https` and `git+http` with `https` or `http`
+    if (protocols.includes('http') || protocols.includes('https')) {
+      repositoryUrl = format({
+        ...parse(repositoryUrl),
+        ...{protocol: protocols.includes('https') ? 'https' : 'http'},
+      });
     }
+  }
 
-    // Test if push is allowed without transforming the URL (e.g. is ssh keys are set up)
-    if (!await verifyAuth(repositoryUrl, branch)) {
-      const envVar = GIT_TOKENS.find(envVar => !isUndefined(process.env[envVar]));
-      const gitCredentials = ['GL_TOKEN', 'GITLAB_TOKEN'].includes(envVar)
-        ? `gitlab-ci-token:${process.env[envVar]}`
-        : process.env[envVar];
-      const {protocols} = gitUrlParse(repositoryUrl);
-      const protocol = protocols.includes('https') ? 'https' : protocols.includes('http') ? 'http' : 'https';
+  // Test if push is allowed without transforming the URL (e.g. is ssh keys are set up)
+  if (!await verifyAuth(repositoryUrl, branch)) {
+    const envVar = GIT_TOKENS.find(envVar => !isUndefined(process.env[envVar]));
+    const gitCredentials = ['GL_TOKEN', 'GITLAB_TOKEN'].includes(envVar)
+      ? `gitlab-ci-token:${process.env[envVar]}`
+      : process.env[envVar];
+    const {protocols} = gitUrlParse(repositoryUrl);
+    const protocol = protocols.includes('https') ? 'https' : protocols.includes('http') ? 'http' : 'https';
 
-      // If credentials are set via anvironment variables, convert the URL to http/https and add basic auth, otherwise return `repositoryUrl` as is
-      return gitCredentials
-        ? format({...parse(`${gitUrlParse(repositoryUrl).toString(protocol)}.git`), ...{auth: gitCredentials}})
-        : repositoryUrl;
-    }
+    // If credentials are set via anvironment variables, convert the URL to http/https and add basic auth, otherwise return `repositoryUrl` as is
+    return gitCredentials
+      ? format({...parse(`${gitUrlParse(repositoryUrl).toString(protocol)}.git`), ...{auth: gitCredentials}})
+      : repositoryUrl;
   }
   return repositoryUrl;
 };

lib/get-last-release.js

@@ -28,11 +28,10 @@ module.exports = async (tagFormat, logger) => {
   // by replacing the `version` variable in the template by `(.+)`.
   // The `tagFormat` is compiled with space as the `version` as it's an invalid tag character,
   // so it's guaranteed to no be present in the `tagFormat`.
-  const tagRegexp = escapeRegExp(template(tagFormat)({version: ' '})).replace(' ', '(.+)');
+  const tagRegexp = `^${escapeRegExp(template(tagFormat)({version: ' '})).replace(' ', '(.+)')}`;
+
   const tags = (await gitTags())
-    .map(tag => {
-      return {gitTag: tag, version: (tag.match(tagRegexp) || new Array(2))[1]};
-    })
+    .map(tag => ({gitTag: tag, version: (tag.match(tagRegexp) || new Array(2))[1]}))
     .filter(
       tag => tag.version && semver.valid(semver.clean(tag.version)) && !semver.prerelease(semver.clean(tag.version))
     )
@@ -40,14 +39,11 @@ module.exports = async (tagFormat, logger) => {
 
   debug('found tags: %o', tags);
 
-  if (tags.length > 0) {
-    const {gitTag, version} = await pLocate(tags, tag => isRefInHistory(tag.gitTag), {
-      concurrency: 1,
-      preserveOrder: true,
-    });
-    logger.log('Found git tag %s associated with version %s', gitTag, version);
+  const tag = await pLocate(tags, tag => isRefInHistory(tag.gitTag), {concurrency: 1, preserveOrder: true});
 
-    return {gitHead: await gitTagHead(gitTag), gitTag, version};
+  if (tag) {
+    logger.log('Found git tag %s associated with version %s', tag.gitTag, tag.version);
+    return {gitHead: await gitTagHead(tag.gitTag), ...tag};
   }
 
   logger.log('No git tag version found');

lib/git.js

@@ -118,7 +118,6 @@ async function push(origin, branch) {
 /**
  * Verify a tag name is a valid Git reference.
  *
- * @method verifyTagName
  * @param {string} tagName the tag name to verify.
  * @return {boolean} `true` if valid, falsy otherwise.
  */

lib/verify.js

@@ -1,6 +1,6 @@
 const {template} = require('lodash');
 const AggregateError = require('aggregate-error');
-const {isGitRepo, verifyAuth, verifyTagName} = require('./git');
+const {isGitRepo, verifyTagName} = require('./git');
 const getError = require('./get-error');
 
 module.exports = async options => {
@@ -10,8 +10,6 @@ module.exports = async options => {
     errors.push(getError('ENOGITREPO'));
   } else if (!options.repositoryUrl) {
     errors.push(getError('ENOREPOURL'));
-  } else if (!await verifyAuth(options.repositoryUrl, options.branch)) {
-    errors.push(getError('EGITNOPERMISSION', {options}));
   }
 
   // Verify that compiling the `tagFormat` produce a valid Git tag

package.json

@@ -32,7 +32,7 @@
     "execa": "^0.10.0",
     "get-stream": "^3.0.0",
     "git-log-parser": "^1.2.0",
-    "git-url-parse": "^8.1.0",
+    "git-url-parse": "^8.3.1",
     "hook-std": "^0.4.0",
     "hosted-git-info": "^2.6.0",
     "lodash": "^4.17.4",

test/get-config.test.js

@@ -31,7 +31,6 @@ test.afterEach.always(() => {
 });
 
 test.serial('Default values, reading repositoryUrl from package.json', async t => {
-  process.env.GIT_CREDENTIALS = 'user:pass';
   const pkg = {repository: 'https://host.null/owner/package.git'};
   // Create a git repository, set the current working directory at the root of the repo
   await gitRepo();
@@ -45,12 +44,11 @@ test.serial('Default values, reading repositoryUrl from package.json', async t =
 
   // Verify the default options are set
   t.is(options.branch, 'master');
-  t.is(options.repositoryUrl, 'https://user:pass@host.null/owner/package.git');
+  t.is(options.repositoryUrl, 'https://host.null/owner/package.git');
   t.is(options.tagFormat, `v\${version}`);
 });
 
 test.serial('Default values, reading repositoryUrl from repo if not set in package.json', async t => {
-  process.env.GIT_CREDENTIALS = 'user:pass';
   // Create a git repository, set the current working directory at the root of the repo
   await gitRepo();
   // Add remote.origin.url config
@@ -60,12 +58,11 @@ test.serial('Default values, reading repositoryUrl from repo if not set in packa
 
   // Verify the default options are set
   t.is(options.branch, 'master');
-  t.is(options.repositoryUrl, 'https://user:pass@host.null/owner/module.git');
+  t.is(options.repositoryUrl, 'https://host.null/owner/module.git');
   t.is(options.tagFormat, `v\${version}`);
 });
 
 test.serial('Default values, reading repositoryUrl (http url) from package.json if not set in repo', async t => {
-  process.env.GIT_CREDENTIALS = 'user:pass';
   const pkg = {repository: 'https://host.null/owner/module.git'};
   // Create a git repository, set the current working directory at the root of the repo
   await gitRepo();
@@ -76,58 +73,10 @@ test.serial('Default values, reading repositoryUrl (http url) from package.json
 
   // Verify the default options are set
   t.is(options.branch, 'master');
-  t.is(options.repositoryUrl, 'https://user:pass@host.null/owner/module.git');
+  t.is(options.repositoryUrl, 'https://host.null/owner/module.git');
   t.is(options.tagFormat, `v\${version}`);
 });
 
-test.serial('Default values, reading repositoryUrl (shorthand url) from package.json if not set in repo', async t => {
-  process.env.GIT_CREDENTIALS = 'user:pass';
-  const pkg = {repository: 'owner/module'};
-  // Create a git repository, set the current working directory at the root of the repo
-  await gitRepo();
-  // Create package.json in repository root
-  await outputJson('./package.json', pkg);
-
-  const {options} = await t.context.getConfig();
-
-  // Verify the default options are set
-  t.is(options.branch, 'master');
-  t.is(options.repositoryUrl, 'https://user:pass@github.com/owner/module.git');
-  t.is(options.tagFormat, `v\${version}`);
-});
-
-test.serial(
-  'Default values, reading repositoryUrl (gitlab shorthand url) from package.json if not set in repo',
-  async t => {
-    process.env.GIT_CREDENTIALS = 'user:pass';
-    const pkg = {repository: 'gitlab:owner/module'};
-    // Create a git repository, set the current working directory at the root of the repo
-    await gitRepo();
-    // Create package.json in repository root
-    await outputJson('./package.json', pkg);
-
-    const {options} = await t.context.getConfig();
-
-    // Verify the default options are set
-    t.is(options.branch, 'master');
-    t.is(options.repositoryUrl, 'https://user:pass@gitlab.com/owner/module.git');
-    t.is(options.tagFormat, `v\${version}`);
-  }
-);
-
-test.serial('Do not add git credential to repositoryUrl if push is allowed', async t => {
-  process.env.GIT_CREDENTIALS = 'user:pass';
-  // Create a git repository, set the current working directory at the root of the repo
-  const repositoryUrl = await gitRepo(true);
-  const pkg = {repository: repositoryUrl};
-  // Create package.json in repository root
-  await outputJson('./package.json', pkg);
-
-  const {options} = await t.context.getConfig();
-
-  t.is(options.repositoryUrl, repositoryUrl);
-});
-
 test.serial('Read options from package.json', async t => {
   const release = {
     analyzeCommits: {path: 'analyzeCommits', param: 'analyzeCommits_param'},

test/get-git-auth-url.test.js

@@ -51,6 +51,20 @@ test.serial('Handle "git" URL with group and subgroup', async t => {
   );
 });
 
+test.serial('Convert shorthand URL', async t => {
+  t.is(
+    await getAuthUrl({repositoryUrl: 'semanitc-release/semanitc-release'}),
+    'https://github.com/semanitc-release/semanitc-release.git'
+  );
+});
+
+test.serial('Convert GitLab shorthand URL', async t => {
+  t.is(
+    await getAuthUrl({repositoryUrl: 'gitlab:semanitc-release/semanitc-release'}),
+    'https://gitlab.com/semanitc-release/semanitc-release.git'
+  );
+});
+
 test.serial(
   'Return the "https" formatted URL if "gitCredentials" is defined and repositoryUrl is a "git" URL',
   async t => {

test/get-last-release.test.js

@@ -62,6 +62,19 @@ test.serial('Get the highest tag in the history of the current branch', async t
   t.deepEqual(result, {gitHead: commits[0].hash, gitTag: 'v2.0.0', version: '2.0.0'});
 });
 
+test.serial('Match the tag name from the begining of the string', async t => {
+  // Create a git repository, set the current working directory at the root of the repo
+  await gitRepo();
+  const commits = await gitCommits(['First']);
+  await gitTagVersion('prefix/v1.0.0');
+  await gitTagVersion('prefix/v2.0.0');
+  await gitTagVersion('other-prefix/v3.0.0');
+
+  const result = await getLastRelease(`prefix/v\${version}`, t.context.logger);
+
+  t.deepEqual(result, {gitHead: commits[0].hash, gitTag: 'prefix/v2.0.0', version: '2.0.0'});
+});
+
 test.serial('Return empty object if no valid tag is found', async t => {
   // Create a git repository, set the current working directory at the root of the repo
   await gitRepo();
@@ -79,6 +92,23 @@ test.serial('Return empty object if no valid tag is found', async t => {
   t.is(t.context.log.args[0][0], 'No git tag version found');
 });
 
+test.serial('Return empty object if no valid tag is found in history', async t => {
+  // Create a git repository, set the current working directory at the root of the repo
+  await gitRepo();
+  await gitCommits(['First']);
+  await gitCheckout('other-branch');
+  await gitCommits(['Second']);
+  await gitTagVersion('v1.0.0');
+  await gitTagVersion('v2.0.0');
+  await gitTagVersion('v3.0.0');
+  await gitCheckout('master', false);
+
+  const result = await getLastRelease(`v\${version}`, t.context.logger);
+
+  t.deepEqual(result, {});
+  t.is(t.context.log.args[0][0], 'No git tag version found');
+});
+
 test.serial('Get the highest valid tag corresponding to the "tagFormat"', async t => {
   // Create a git repository, set the current working directory at the root of the repo
   await gitRepo();