fix(docs): remove unnecessary backticks in readme

Add `author`, `commiter`, `gitTags` and `committerDate` to the commit object passed to plugin

.github/airtable-crm.yml

@@ -0,0 +1 @@
+base: app0ZOxG0FnHmOiuU

README.md

@@ -87,8 +87,8 @@ When pushing new commits with `git push` a CI build is triggered. After running
 
 | Step               | Description                                                                                 |
 | ------------------ | ------------------------------------------------------------------------------------------- |
-| Verify Conditions` | Run the [verifyConditions](#verifyConditions) plugin)                                       |
-| Get last release`  | Obtain last release with the [getLastRelease](#getLastRelease) plugin                       |
+| Verify Conditions  | Run the [verifyConditions](#verifyConditions) plugin)                                       |
+| Get last release   | Obtain last release with the [getLastRelease](#getLastRelease) plugin                       |
 | Analyze commits    | Determine the type of release to do with the [analyzeCommits](#analyzeCommits) plugin       |
 | Verify release     | Call the [verifyRelease](#verifyRelease) plugin                                             |
 | npm publish        | Update the version in `package.json` and call `npm publish`                                 |

package.json

@@ -25,7 +25,9 @@
     "debug": "^3.1.0",
     "execa": "^0.8.0",
     "fs-extra": "^4.0.2",
+    "get-stream": "^3.0.0",
     "git-head": "^1.2.1",
+    "git-log-parser": "^1.2.0",
     "github": "^12.0.0",
     "lodash": "^4.0.0",
     "marked": "^0.3.6",
@@ -52,13 +54,12 @@
     "eslint-plugin-prettier": "^2.3.0",
     "eslint-plugin-promise": "^3.5.0",
     "eslint-plugin-standard": "^3.0.1",
-    "get-stream": "^3.0.0",
     "mockserver-client": "^1.0.16",
     "nock": "^9.0.2",
     "npm-registry-couchapp": "^2.6.12",
     "nyc": "^11.2.1",
     "p-map-series": "^1.0.0",
-    "prettier": "^1.7.0",
+    "prettier": "~1.8.0",
     "proxyquire": "^1.8.0",
     "rimraf": "^2.5.0",
     "sinon": "^4.0.0",

src/lib/get-commits.js

@@ -1,4 +1,6 @@
 const execa = require('execa');
+const gitLogParser = require('git-log-parser');
+const getStream = require('get-stream');
 const debug = require('debug')('semantic-release:get-commits');
 const getVersionHead = require('./get-version-head');
 const {debugShell} = require('./debug');
@@ -6,7 +8,7 @@ const logger = require('./logger');
 
 /**
  * Commit message.
- * 
+ *
  * @typedef {Object} Commit
  * @property {string} hash The commit hash.
  * @property {string} message The commit message.
@@ -14,7 +16,7 @@ const logger = require('./logger');
 
 /**
  * Last release.
- * 
+ *
  * @typedef {Object} LastRelease
  * @property {string} version The version number of the last release.
  * @property {string} [gitHead] The commit sha used to make the last release.
@@ -22,7 +24,7 @@ const logger = require('./logger');
 
 /**
  * Result object.
- * 
+ *
  * @typedef {Object} Result
  * @property {Array<Commit>} commits The list of commits since the last release.
  * @property {LastRelease} lastRelease The updated lastRelease.
@@ -30,7 +32,7 @@ const logger = require('./logger');
 
 /**
  * Retrieve the list of commits on the current branch since the last released version, or all the commits of the current branch if there is no last released version.
- * 
+ *
  * The commit correspoding to the last released version is determined as follow:
  * - Use `lastRelease.gitHead` if defined and present in `branch` history.
  * - If `lastRelease.gitHead` is not in the `branch` history, unshallow the repository and try again.
@@ -39,9 +41,9 @@ const logger = require('./logger');
  * @param {LastRelease} lastRelease The lastRelease object obtained from the getLastRelease plugin.
  * @param {string} branch The branch to release from.
  * @param {Object} logger Global logger.
- * 
+ *
  * @return {Promise<Result>} The list of commits on the branch `branch` since the last release and the updated lastRelease with the gitHead used to retrieve the commits.
- * 
+ *
  * @throws {SemanticReleaseError} with code `ENOTINHISTORY` if `lastRelease.gitHead` or the commit sha derived from `config.lastRelease.version` is not in the direct history of `branch`.
  * @throws {SemanticReleaseError} with code `ENOGITHEAD` if `lastRelease.gitHead` is undefined and no commit sha can be found for the `config.lastRelease.version`.
  */
@@ -65,28 +67,17 @@ module.exports = async ({version, gitHead}, branch) => {
     debugShell('Unshallow repo', shell, debug);
   }
 
-  try {
-    const shell = await execa('git', [
-      'log',
-      '--format=format:%H==SPLIT==%B==END==',
-      `${gitHead ? gitHead + '..' : ''}HEAD`,
-    ]);
-    debugShell('Get commits', shell, debug);
-    const commits = shell.stdout
-      .split('==END==')
-      .filter(raw => !!raw.trim())
-      .map(raw => {
-        const [hash, message] = raw.trim().split('==SPLIT==');
-        return {hash, message};
-      });
-    logger.log('Found %s commits since last release', commits.length);
-    debug('Parsed commits: %o', commits);
-    return {commits, lastRelease: {version, gitHead}};
-  } catch (err) {
-    debug(err);
-    logger.log('Found no commit since last release');
-    return {commits: [], lastRelease: {version, gitHead}};
-  }
+  Object.assign(gitLogParser.fields, {hash: 'H', message: 'B', gitTags: 'd', committerDate: {key: 'ci', type: Date}});
+  const commits = (await getStream.array(gitLogParser.parse({_: `${gitHead ? gitHead + '..' : ''}HEAD`}))).map(
+    commit => {
+      commit.message = commit.message.trim();
+      commit.gitTags = commit.gitTags.trim();
+      return commit;
+    }
+  );
+  logger.log('Found %s commits since last release', commits.length);
+  debug('Parsed commits: %o', commits);
+  return {commits, lastRelease: {version, gitHead}};
 };
 
 function noGitHeadMessage(branch, version) {
@@ -94,18 +85,24 @@ function noGitHeadMessage(branch, version) {
 This means semantic-release can not extract the commits between now and then.
 This is usually caused by releasing from outside the repository directory or with innaccessible git metadata.
 
-You can recover from this error by creating a tag for the version "${version}" on the commit corresponding to this release:
+You can recover from this error by creating a tag for the version "${
+    version
+  }" on the commit corresponding to this release:
 $ git tag -f v${version} <commit sha1 corresponding to last release>
 $ git push -f --tags origin ${branch}
 `;
 }
 
 function notInHistoryMessage(gitHead, branch, version) {
-  return `The commit the last release of this package was derived from is not in the direct history of the "${branch}" branch.
+  return `The commit the last release of this package was derived from is not in the direct history of the "${
+    branch
+  }" branch.
 This means semantic-release can not extract the commits between now and then.
 This is usually caused by force pushing, releasing from an unrelated branch, or using an already existing package name.
 
-You can recover from this error by restoring the commit "${gitHead}" or by creating a tag for the version "${version}" on the commit corresponding to this release:
+You can recover from this error by restoring the commit "${gitHead}" or by creating a tag for the version "${
+    version
+  }" on the commit corresponding to this release:
 $ git tag -f v${version || '<version>'} <commit sha1 corresponding to last release>
 $ git push -f --tags origin ${branch}
 `;

src/lib/get-version-head.js

@@ -7,7 +7,7 @@ const {debugShell} = require('./debug');
  * Get the commit sha for a given tag.
  *
  * @param {string} tagName Tag name for which to retrieve the commit sha.
- * 
+ *
  * @return {string} The commit sha of the tag in parameter or `null`.
  */
 async function gitTagHead(tagName) {
@@ -23,9 +23,9 @@ async function gitTagHead(tagName) {
 
 /**
  * Verify if the commist `sha` is in the direct history of the current branch.
- * 
+ *
  * @param {string} sha The sha of the commit to look for.
- * 
+ *
  * @return {boolean} `true` if the commit `sha` is in the history of the current branch, `false` otherwise.
  */
 async function isCommitInHistory(sha) {
@@ -39,9 +39,9 @@ async function isCommitInHistory(sha) {
  *
  * @param {string} gitHead The commit sha to look for.
  * @param {string} version The version corresponding to the commit sha to look for. Used to search in git tags.
- * 
+ *
  * @return {Promise<string>} A Promise that resolves to the commit sha of the version, either `gitHead` of the commit associated with the `version` tag.
- * 
+ *
  * @throws {SemanticReleaseError} with code `ENOTINHISTORY` if `gitHead` or the commit sha dereived from `version` is not in the direct history of `branch`.
  * @throws {SemanticReleaseError} with code `ENOGITHEAD` if `gitHead` is undefined and no commit sha can be found for the `version`.
  */

src/lib/logger.js

@@ -7,9 +7,9 @@ module.exports = {
   log(...args) {
     const [format, ...rest] = args;
     console.log(
-      `${chalk.grey('[Semantic release]:')}${typeof format === 'string'
-        ? ` ${format.replace(/%[^%]/g, seq => chalk.magenta(seq))}`
-        : ''}`,
+      `${chalk.grey('[Semantic release]:')}${
+        typeof format === 'string' ? ` ${format.replace(/%[^%]/g, seq => chalk.magenta(seq))}` : ''
+      }`,
       ...(typeof format === 'string' ? [] : [format]).concat(rest)
     );
   },

test/get-commits.test.js

@@ -42,14 +42,48 @@ test.serial('Get all commits when there is no last release', async t => {
   t.is(result.commits.length, 2);
   t.is(result.commits[0].hash.substring(0, 7), commits[0].hash);
   t.is(result.commits[0].message, commits[0].message);
+  t.truthy(result.commits[0].committerDate);
+  t.truthy(result.commits[0].author.name);
+  t.truthy(result.commits[0].committer.name);
   t.is(result.commits[1].hash.substring(0, 7), commits[1].hash);
   t.is(result.commits[1].message, commits[1].message);
+  t.truthy(result.commits[1].committerDate);
+  t.truthy(result.commits[1].author.name);
+  t.truthy(result.commits[1].committer.name);
   // Verify the last release is returned and updated
   t.truthy(result.lastRelease);
   t.falsy(result.lastRelease.gitHead);
   t.falsy(result.lastRelease.version);
 });
 
+test.serial('Get all commits with gitTags', 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);
+
+  // Retrieve the commits with the commits module
+  const result = await t.context.getCommits({}, 'master');
+  // Verify the commits created and retrieved by the module are identical
+  t.is(result.commits.length, 2);
+  t.is(result.commits[0].hash.substring(0, 7), commits[0].hash);
+  t.is(result.commits[0].message, commits[0].message);
+  t.truthy(result.commits[0].committerDate);
+  t.truthy(result.commits[0].author.name);
+  t.truthy(result.commits[0].committer.name);
+  t.is(result.commits[0].gitTags, '(HEAD -> master)');
+  t.is(result.commits[1].hash.substring(0, 7), commits[1].hash);
+  t.is(result.commits[1].message, commits[1].message);
+  t.truthy(result.commits[1].committerDate);
+  t.truthy(result.commits[1].author.name);
+  t.truthy(result.commits[1].committer.name);
+  t.is(result.commits[1].gitTags, '(tag: v1.0.0)');
+});
+
 test.serial('Get all commits when there is no last release, including the ones not in the shallow clone', async t => {
   // Create a git repository, set the current working directory at the root of the repo
   const repo = await gitRepo();
@@ -68,8 +102,14 @@ test.serial('Get all commits when there is no last release, including the ones n
   t.is(result.commits.length, 2);
   t.is(result.commits[0].hash.substring(0, 7), commits[0].hash);
   t.is(result.commits[0].message, commits[0].message);
+  t.truthy(result.commits[0].committerDate);
+  t.truthy(result.commits[0].author.name);
+  t.truthy(result.commits[0].committer.name);
   t.is(result.commits[1].hash.substring(0, 7), commits[1].hash);
   t.is(result.commits[1].message, commits[1].message);
+  t.truthy(result.commits[1].committerDate);
+  t.truthy(result.commits[1].author.name);
+  t.truthy(result.commits[1].committer.name);
   // Verify the last release is returned and updated
   t.truthy(result.lastRelease);
   t.falsy(result.lastRelease.gitHead);
@@ -89,8 +129,14 @@ test.serial('Get all commits since gitHead (from lastRelease)', async t => {
   t.is(result.commits.length, 2);
   t.is(result.commits[0].hash.substring(0, 7), commits[0].hash);
   t.is(result.commits[0].message, commits[0].message);
+  t.truthy(result.commits[0].committerDate);
+  t.truthy(result.commits[0].author.name);
+  t.truthy(result.commits[0].committer.name);
   t.is(result.commits[1].hash.substring(0, 7), commits[1].hash);
   t.is(result.commits[1].message, commits[1].message);
+  t.truthy(result.commits[1].committerDate);
+  t.truthy(result.commits[1].author.name);
+  t.truthy(result.commits[1].committer.name);
   // Verify the last release is returned and updated
   t.truthy(result.lastRelease);
   t.is(result.lastRelease.gitHead, commits[commits.length - 1].hash);
@@ -112,6 +158,9 @@ test.serial('Get all commits since gitHead (from lastRelease) on a detached head
   t.is(result.commits.length, 1);
   t.is(result.commits[0].hash.substring(0, 7), commits[1].hash);
   t.is(result.commits[0].message, commits[1].message);
+  t.truthy(result.commits[0].committerDate);
+  t.truthy(result.commits[0].author.name);
+  t.truthy(result.commits[0].committer.name);
   // Verify the last release is returned and updated
   t.truthy(result.lastRelease);
   t.is(result.lastRelease.gitHead, commits[commits.length - 1].hash);
@@ -135,8 +184,14 @@ test.serial('Get all commits since gitHead (from tag) ', async t => {
   t.is(result.commits.length, 2);
   t.is(result.commits[0].hash.substring(0, 7), commits[0].hash);
   t.is(result.commits[0].message, commits[0].message);
+  t.truthy(result.commits[0].committerDate);
+  t.truthy(result.commits[0].author.name);
+  t.truthy(result.commits[0].committer.name);
   t.is(result.commits[1].hash.substring(0, 7), commits[1].hash);
   t.is(result.commits[1].message, commits[1].message);
+  t.truthy(result.commits[1].committerDate);
+  t.truthy(result.commits[1].author.name);
+  t.truthy(result.commits[1].committer.name);
   // Verify the last release is returned and updated
   t.truthy(result.lastRelease);
   t.is(result.lastRelease.gitHead.substring(0, 7), commits[commits.length - 1].hash);
@@ -162,6 +217,9 @@ test.serial('Get all commits since gitHead (from tag) on a detached head repo',
   t.is(result.commits.length, 1);
   t.is(result.commits[0].hash.substring(0, 7), commits[1].hash);
   t.is(result.commits[0].message, commits[1].message);
+  t.truthy(result.commits[0].committerDate);
+  t.truthy(result.commits[0].author.name);
+  t.truthy(result.commits[0].committer.name);
   // Verify the last release is returned and updated
   t.truthy(result.lastRelease);
   t.is(result.lastRelease.gitHead.substring(0, 7), commits[commits.length - 1].hash);
@@ -185,8 +243,14 @@ test.serial('Get all commits since gitHead (from tag formatted like v<version>)
   t.is(result.commits.length, 2);
   t.is(result.commits[0].hash.substring(0, 7), commits[0].hash);
   t.is(result.commits[0].message, commits[0].message);
+  t.truthy(result.commits[0].committerDate);
+  t.truthy(result.commits[0].author.name);
+  t.truthy(result.commits[0].committer.name);
   t.is(result.commits[1].hash.substring(0, 7), commits[1].hash);
   t.is(result.commits[1].message, commits[1].message);
+  t.truthy(result.commits[1].committerDate);
+  t.truthy(result.commits[1].author.name);
+  t.truthy(result.commits[1].committer.name);
   // Verify the last release is returned and updated
   t.truthy(result.lastRelease);
   t.is(result.lastRelease.gitHead.substring(0, 7), commits[commits.length - 1].hash);
@@ -210,8 +274,14 @@ test.serial('Get commits when last release gitHead is missing but a tag match th
   t.is(result.commits.length, 2);
   t.is(result.commits[0].hash.substring(0, 7), commits[0].hash);
   t.is(result.commits[0].message, commits[0].message);
+  t.truthy(result.commits[0].committerDate);
+  t.truthy(result.commits[0].author.name);
+  t.truthy(result.commits[0].committer.name);
   t.is(result.commits[1].hash.substring(0, 7), commits[1].hash);
   t.is(result.commits[1].message, commits[1].message);
+  t.truthy(result.commits[1].committerDate);
+  t.truthy(result.commits[1].author.name);
+  t.truthy(result.commits[1].committer.name);
   // Verify the last release is returned and updated
   t.truthy(result.lastRelease);
   t.is(result.lastRelease.gitHead.substring(0, 7), commits[commits.length - 1].hash);
@@ -233,8 +303,14 @@ test.serial('Get all commits since gitHead, when gitHead are mising from the sha
   t.is(result.commits.length, 2);
   t.is(result.commits[0].hash.substring(0, 7), commits[0].hash);
   t.is(result.commits[0].message, commits[0].message);
+  t.truthy(result.commits[0].committerDate);
+  t.truthy(result.commits[0].author.name);
+  t.truthy(result.commits[0].committer.name);
   t.is(result.commits[1].hash.substring(0, 7), commits[1].hash);
   t.is(result.commits[1].message, commits[1].message);
+  t.truthy(result.commits[1].committerDate);
+  t.truthy(result.commits[1].author.name);
+  t.truthy(result.commits[1].committer.name);
   // Verify the last release is returned and updated
   t.truthy(result.lastRelease);
   t.is(result.lastRelease.gitHead.substring(0, 7), commits[commits.length - 1].hash);
@@ -263,8 +339,14 @@ test.serial('Get all commits since gitHead from tag, when tags are mising from t
   t.is(result.commits.length, 2);
   t.is(result.commits[0].hash.substring(0, 7), commits[0].hash);
   t.is(result.commits[0].message, commits[0].message);
+  t.truthy(result.commits[0].committerDate);
+  t.truthy(result.commits[0].author.name);
+  t.truthy(result.commits[0].committer.name);
   t.is(result.commits[1].hash.substring(0, 7), commits[1].hash);
   t.is(result.commits[1].message, commits[1].message);
+  t.truthy(result.commits[1].committerDate);
+  t.truthy(result.commits[1].author.name);
+  t.truthy(result.commits[1].committer.name);
   // Verify the last release is returned and updated
   t.truthy(result.lastRelease);
   t.is(result.lastRelease.gitHead.substring(0, 7), commits[commits.length - 1].hash);

test/helpers/git-utils.js

@@ -5,7 +5,7 @@ import pMapSeries from 'p-map-series';
 
 /**
  * Commit message informations.
- * 
+ *
  * @typedef {Object} Commit
  * @property {string} branch The commit branch.
  * @property {string} hash The commit hash.
@@ -13,13 +13,13 @@ import pMapSeries from 'p-map-series';
  */
 
 /**
-  * Create a temporary git repository and change the current working directory to the repository root.
-  *
-  * @method gitCommits
-  * @param {Array<Commit>} commits the created commits.
-  * 
-  * @return {string} The path of the repository.
-  */
+ * Create a temporary git repository and change the current working directory to the repository root.
+ *
+ * @method gitCommits
+ * @param {Array<Commit>} commits the created commits.
+ *
+ * @return {string} The path of the repository.
+ */
 export async function gitRepo() {
   const dir = tempy.directory();
 
@@ -34,7 +34,7 @@ export async function gitRepo() {
  * Create commits on the current git repository.
  *
  * @param {Array<string>} messages commit messages.
- * 
+ *
  * @returns {Array<Commit>} The created commits, in reverse order (to match `git log` order).
  */
 export async function gitCommits(messages) {
@@ -49,7 +49,7 @@ export async function gitCommits(messages) {
  * Amend a commit (rewriting the sha) on the current git repository.
  *
  * @param {string} messages commit message.
- * 
+ *
  * @returns {Array<Commit>} the created commits.
  */
 export async function gitAmmendCommit(msg) {
@@ -105,7 +105,7 @@ export async function gitLog() {
 /**
  * Create a shallow clone of a git repository and change the current working directory to the cloned repository root.
  * The shallow will contain a limited number of commit and no tags.
- * 
+ *
  * @param {string} origin The path of the repository to clone.
  * @param {number} [depth=1] The number of commit to clone.
  * @return {string} The path of the cloned repository.
@@ -120,7 +120,7 @@ export async function gitShallowClone(origin, branch = 'master', depth = 1) {
 
 /**
  * Create a git repo with a detached head from another git repository and change the current working directory to the new repository root.
- * 
+ *
  * @param {string} origin The path of the repository to clone.
  * @param {number} head A commit sha of the origin repo that will become the detached head of the new one.
  * @return {string} The path of the new repository.

test/helpers/mock-github.js

@@ -2,7 +2,7 @@ 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.

test/helpers/mockserver.js

@@ -47,7 +47,7 @@ const url = `http://${MOCK_SERVER_HOST}:${MOCK_SERVER_PORT}`;
  * @param {Object} request Request expectation. The http request made on `path` has to match those criteria in order to be valid.
  * @param {Object} request.body The JSON body the expected request must match.
  * @param {Object} request.headers The headers the expected request must match.
- * @param {Object} response The http response to return when receiving a request on `path`. 
+ * @param {Object} response The http response to return when receiving a request on `path`.
  * @param {String} [response.method='POST'] The http method for which to respond.
  * @param {number} [response.statusCode=200] The status code to respond.
  * @param {Object} response.body The JSON object to respond in the response body.

test/integration.test.js

@@ -408,7 +408,9 @@ test.serial('Create a tag as a recovery solution for "ENOTINHISTORY" error', asy
   t.regex(
     stderr,
     new RegExp(
-      `You can recover from this error by restoring the commit "${head}" or by creating a tag for the version "${version}" on the commit corresponding to this release`
+      `You can recover from this error by restoring the commit "${head}" or by creating a tag for the version "${
+        version
+      }" on the commit corresponding to this release`
     )
   );