feat: create changelog file with dedicated plugin

BREAKING CHANGE: The `changelog` options has been removed. The `CHANGELOG.md` is not created or updated anymore.
Use https://github.com/semantic-release/changelog to create/update the `CHANGELOG.md`.
By default if a `CHANGELOG.md` file exists and has been modified it will be included in the release commit.

Author: pvdlg

README.md

@@ -16,7 +16,7 @@ Determine the Git tag and version of the last tagged release.
 
 ## publish
 
-Update the `CHANGELOG.md` file and publish a release commit, optionnaly including addtional files.
+Publish a release commit, including configurable files.
 
 ## Configuration
 
@@ -32,7 +32,7 @@ Using the `GIT_CREDENTIALS` environment variable is the recommended configuratio
 
 `GIT_CREDENTIALS` can be your Git username and passort in the format `<username>:<password>` or a token for certain Git providers like [Github](https://help.github.com/articles/creating-a-personal-access-token-for-the-command-line/), [Bitbucket](https://confluence.atlassian.com/bitbucketserver/personal-access-tokens-939515499.html) or [Gitlab](https://docs.gitlab.com/ce/user/profile/personal_access_tokens.html).
 
-If the `GH_TOKEN` or `GITHUB_TOKEN` environment variables are defined their value will be used as a replacement for `GIT_CREDENTIALS`. 
+If the `GH_TOKEN` or `GITHUB_TOKEN` environment variables are defined their value will be used as a replacement for `GIT_CREDENTIALS`.
 
 ### Environment variables
 
@@ -46,7 +46,6 @@ If the `GH_TOKEN` or `GITHUB_TOKEN` environment variables are defined their valu
 
 | Options        | Description                                                    | Default                                                                     |
 | -------------- | -------------------------------------------------------------- | --------------------------------------------------------------------------- |
-| `changelog`    | Whether to create/update the `CHANGELOG.md` file.              | `true`                                                                      |
 | `message`      | The message for the release commit. See [message](#message).   | `chore(release): ${nextRelease.version} [skip ci]\n\n${nextRelease.notes}`  |
 | `assets`       | Files to include in the release commit. See [assets](#assets). | `["package.json", "npm-shrinkwrap.json"]`                                   |
 
@@ -113,18 +112,19 @@ Options can be set within the plugin definition in the `semantic-release` config
 }
 ```
 
-When using with the [npm](https://github.com/semantic-release/npm) plugin or the [github](https://github.com/semantic-release/github) plugin:
-- The [npm](https://github.com/semantic-release/npm) plugin must be called first in order to update the `package.json` file so the [git](https://github.com/semantic-release/git) plugin can include it in the release commit.
+When using with the [changelog](https://github.com/semantic-release/changelog), [npm](https://github.com/semantic-release/npm) or [github](https://github.com/semantic-release/github) plugins:
+- The [changelog](https://github.com/semantic-release/changelog) plugin must be called first in order to update the changelog file so the [git](https://github.com/semantic-release/git) and [npm](https://github.com/semantic-release/npm) plugin can include it in the release.
+- The [npm](https://github.com/semantic-release/npm) plugin must be called second in order to update the `package.json` file so the [git](https://github.com/semantic-release/git) plugin can include it in the release commit.
 - The [github](https://github.com/semantic-release/github) plugin must be called last to create a [Github Release](https://help.github.com/articles/about-releases/) that reference the tag created by the [git](https://github.com/semantic-release/git) plugin.
 
-To use with [github](https://github.com/semantic-release/github), [npm](https://github.com/semantic-release/npm) and [condition-travis](https://github.com/semantic-release/condition-travis):
+To use with the [changelog](https://github.com/semantic-release/changelog), [github](https://github.com/semantic-release/github), [npm](https://github.com/semantic-release/npm) and [condition-travis](https://github.com/semantic-release/condition-travis) plugins:
 
 ```json
 {
   "release": {
-    "verifyConditions": ["@semantic-release/condition-travis", "@semantic-release/npm", "@semantic-release/git", "@semantic-release/github"],
+    "verifyConditions": ["@semantic-release/condition-travis", "@semantic-release/changelog", "@semantic-release/npm", "@semantic-release/git", "@semantic-release/github"],
     "getLastRelease": "@semantic-release/npm",
-    "publish": ["@semantic-release/npm", "@semantic-release/git", "@semantic-release/github"]
+    "publish": ["@semantic-release/changelog", "@semantic-release/npm", "@semantic-release/git", "@semantic-release/github"]
   }
 }
 ```
@@ -330,7 +330,7 @@ $ travis login
 Add the [environment](https://github.com/travis-ci/travis.rb#env) variable `SSH_PASSPHRASE` to Travis with the value set during the [SSH keys generation](#generate-the-ssh-keys) step:
 
 ```bash
-$ travis env set SSH_PASSPHRASE <ssh_passphrase> 
+$ travis env set SSH_PASSPHRASE <ssh_passphrase>
 ```
 
 [Encrypt](https://github.com/travis-ci/travis.rb#encrypt) the `git_deploy_key` (private key) using a symmetric encryption (AES-256), and store the secret in a secure environment variable in the Travis environment:

lib/publish.js

@@ -1,4 +1,4 @@
-const {readFile, writeFile, ensureFile, pathExists} = require('fs-extra');
+const {pathExists} = require('fs-extra');
 const {isUndefined, isPlainObject, isArray} = require('lodash');
 const {template, castArray, uniq} = require('lodash');
 const micromatch = require('micromatch');
@@ -14,14 +14,13 @@ const PKG_JSON = 'package.json';
 const SKW_JSON = 'npm-shrinkwrap.json';
 
 /**
- * Update the `CHANGELOG.md` file and publish a release commit optionnaly including addtional files.
+ * Publish a release commit including configurable files.
  *
  * @param {Object} pluginConfig The plugin configuration.
  * @param {String|Array<String>} [pluginConfig.assets] Files to include in the release commit. Can be files path or globs.
  * @param {String} [pluginConfig.message] The message for the release commit.
  * @param {String} [pluginConfig.gitUserName] The username to use for commiting (git `user.name` config).
  * @param {String} [pluginConfig.gitUserEmail] The email to use for commiting (git `user.email` config).
- * @param {String} [pluginConfig.changelog] If `false` do not include the `CHANGELOG.md`.
  * @param {Object} options `semantic-release` configuration.
  * @param {String} options.repositoryUrl The remote git repository URL.
  * @param {String} options.branch The remote branch to publish to.
@@ -37,23 +36,14 @@ const SKW_JSON = 'npm-shrinkwrap.json';
  * @param {Object} logger Global logger.
  */
 module.exports = async (pluginConfig, {branch, repositoryUrl}, lastRelease, nextRelease, logger) => {
-  const {gitCredentials, gitUserEmail, gitUserName, changelog, message, assets} = resolveConfig(pluginConfig);
+  const {gitCredentials, gitUserEmail, gitUserName, message, assets} = resolveConfig(pluginConfig);
   const patterns = [];
-  if (changelog !== false && nextRelease.notes) {
-    await ensureFile(CHANGELOG);
-    const changelogFile = (await readFile(CHANGELOG)).toString().trim();
-    if (changelogFile) {
-      logger.log('Update %s', CHANGELOG);
-    } else {
-      logger.log('Create %s', CHANGELOG);
-    }
-    await writeFile(CHANGELOG, `${nextRelease.notes.trim()}\n${changelogFile ? `\n${changelogFile}\n` : ''}`);
+  const modifiedFiles = await getModifiedFiles();
+
+  if (isUndefined(assets) && (await pathExists(CHANGELOG))) {
     logger.log('Add %s to the release commit', CHANGELOG);
     patterns.push(CHANGELOG);
   }
-
-  const modifiedFiles = await getModifiedFiles();
-
   if (isUndefined(assets) && (await pathExists(PKG_JSON))) {
     logger.log('Add %s to the release commit', PKG_JSON);
     patterns.push(PKG_JSON);
@@ -106,5 +96,5 @@ module.exports = async (pluginConfig, {branch, repositoryUrl}, lastRelease, next
   logger.log('Creating tag %s', nextRelease.gitTag);
   await tag(nextRelease.gitTag);
   await push(url, branch);
-  logger.log('Published Github release: %s', nextRelease.gitTag);
+  logger.log('Published Git release: %s', nextRelease.gitTag);
 };

lib/resolve-config.js

@@ -1,10 +1,9 @@
 const {castArray} = require('lodash');
 
-module.exports = ({changelog, message, assets, githubToken}) => ({
+module.exports = ({message, assets, githubToken}) => ({
   gitCredentials: process.env.GIT_CREDENTIALS || githubToken || process.env.GH_TOKEN || process.env.GITHUB_TOKEN,
   gitUserName: process.env.GIT_USERNAME || 'semantic-release-bot',
   gitUserEmail: process.env.GIT_EMAIL || 'semantic-release-bot@martynus.net',
-  changelog,
   message,
   assets: assets ? castArray(assets) : assets,
 });

lib/verify.js

@@ -1,4 +1,4 @@
-const {isString, isUndefined, isArray, isPlainObject, isBoolean} = require('lodash');
+const {isString, isUndefined, isArray, isPlainObject} = require('lodash');
 const SemanticReleaseError = require('@semantic-release/error');
 const resolveConfig = require('./resolve-config');
 const getAuthUrl = require('./get-auth-url');
@@ -20,7 +20,7 @@ const {verifyAuth} = require('./git');
  */
 module.exports = async (pluginConfig, {repositoryUrl, branch}, logger) => {
   logger.log('Verify authentication for repository %s', repositoryUrl);
-  const {changelog, message, assets, gitCredentials} = resolveConfig(pluginConfig);
+  const {message, assets, gitCredentials} = resolveConfig(pluginConfig);
 
   if (
     !isUndefined(assets) &&
@@ -36,10 +36,6 @@ module.exports = async (pluginConfig, {repositoryUrl, branch}, logger) => {
     );
   }
 
-  if (!isUndefined(changelog) && !isBoolean(changelog)) {
-    throw new SemanticReleaseError('The "changelog" options, if defined, must be a Boolean.', 'EINVALIDCHANGELOG');
-  }
-
   if (!isUndefined(message) && !(isString(message) && message.trim())) {
     throw new SemanticReleaseError('The "message" options, if defined, must be a non empty String.', 'EINVALIDMESSAGE');
   }

test/integration.test.js

@@ -1,4 +1,4 @@
-import {outputFile, readFile} from 'fs-extra';
+import {outputFile} from 'fs-extra';
 import test from 'ava';
 import {stub} from 'sinon';
 import clearModule from 'clear-module';
@@ -156,7 +156,6 @@ test.serial('Publish from a shallow clone', async t => {
   const branch = 'master';
   // Create a remote repo, initialize it, create a local shallow clone and set the cwd to the clone
   const {repositoryUrl, authUrl} = await gitbox.createRepo('publish', branch);
-  await outputFile('CHANGELOG.md', 'Version 1.0.0 changelog');
   await outputFile('package.json', "{name: 'test-package', version: '1.0.0'}");
   await outputFile('dist/file.js', 'Initial content');
   await outputFile('dist/file.css', 'Initial content');
@@ -176,8 +175,7 @@ test.serial('Publish from a shallow clone', async t => {
   };
   await t.context.m.publish(pluginConfig, {logger: t.context.logger, options: {repositoryUrl, branch}, nextRelease});
 
-  t.is((await readFile('CHANGELOG.md')).toString(), `${nextRelease.notes}\n\nVersion 1.0.0 changelog\n`);
-  t.deepEqual(await gitCommitedFiles(), ['CHANGELOG.md', 'dist/file.js', 'package.json']);
+  t.deepEqual(await gitCommitedFiles(), ['dist/file.js', 'package.json']);
   const commit = (await gitGetCommit())[0];
   t.is(commit.subject, `Release version ${nextRelease.version} from branch ${branch}`);
   t.is(commit.body, `${nextRelease.notes}\n`);
@@ -191,7 +189,6 @@ test.serial('Publish from a detached head repository', async t => {
   const branch = 'master';
   // Create a remote repo, initialize it, create a local shallow clone and set the cwd to the clone
   const {repositoryUrl, authUrl} = await gitbox.createRepo('publish-detached-head', branch);
-  await outputFile('CHANGELOG.md', 'Version 1.0.0 changelog');
   await outputFile('package.json', "{name: 'test-package', version: '1.0.0'}");
   await outputFile('dist/file.js', 'Initial content');
   await outputFile('dist/file.css', 'Initial content');
@@ -211,8 +208,7 @@ test.serial('Publish from a detached head repository', async t => {
   };
   await t.context.m.publish(pluginConfig, {logger: t.context.logger, options: {repositoryUrl, branch}, nextRelease});
 
-  t.is((await readFile('CHANGELOG.md')).toString(), `${nextRelease.notes}\n\nVersion 1.0.0 changelog\n`);
-  t.deepEqual(await gitCommitedFiles(), ['CHANGELOG.md', 'dist/file.js', 'package.json']);
+  t.deepEqual(await gitCommitedFiles(), ['dist/file.js', 'package.json']);
   const commit = (await gitGetCommit())[0];
   t.is(commit.subject, `Release version ${nextRelease.version} from branch ${branch}`);
   t.is(commit.body, `${nextRelease.notes}\n`);
@@ -224,7 +220,7 @@ test.serial('Verify authentication only on the fist call', async t => {
   const branch = 'master';
   // Create a remote repo, initialize it, create a local shallow clone and set the cwd to the clone
   const {repositoryUrl} = await gitbox.createRepo('complete-release', branch);
-  const nextRelease = {version: '2.0.0', gitTag: 'v2.0.0', notes: 'Version 2.0.0 changelog'};
+  const nextRelease = {version: '2.0.0', gitTag: 'v2.0.0'};
 
   await t.notThrows(t.context.m.verifyConditions({}, {logger: t.context.logger, options: {repositoryUrl, branch}}));
   t.falsy(await t.context.m.getLastRelease({}, {logger: t.context.logger, options: {repositoryUrl, branch}}));