@semantic-release/release-notes-generator 6.1.1 → 7.0.0

package/index.js

@@ -13,21 +13,27 @@ const HOSTS_CONFIG = require('./lib/hosts-config');
 /**
  * Generate the changelog for all the commits in `options.commits`.
  *
- * @param {Object} [pluginConfig={}] semantic-release configuration.
+ * @param {Object} pluginConfig The plugin configuration.
  * @param {String} pluginConfig.preset conventional-changelog preset ('angular', 'atom', 'codemirror', 'ember', 'eslint', 'express', 'jquery', 'jscs', 'jshint').
- * @param {String} pluginConfig.config requierable npm package with a custom conventional-changelog preset
- * @param {Object} pluginConfig.parserOpts additional `conventional-changelog-parser` options that will overwrite ones loaded by `preset` or `config`.
- * @param {Object} pluginConfig.writerOpts additional `conventional-changelog-writer` options that will overwrite ones loaded by `preset` or `config`.
- * @param {Object} options semantic-release options.
- * @param {Array<Object>} options.commits array of commits, each containing `hash` and `message`.
- * @param {Object} options.lastRelease last release with `gitHead` corresponding to the commit hash used to make the last release and `gitTag` corresponding to the git tag associated with `gitHead`.
- * @param {Object} options.nextRelease next release with `gitHead` corresponding to the commit hash used to make the  release, the release `version` and `gitTag` corresponding to the git tag associated with `gitHead`.
- * @param {Object} options.options.repositoryUrl git repository URL.
+ * @param {String} pluginConfig.config Requierable npm package with a custom conventional-changelog preset
+ * @param {Object} pluginConfig.parserOpts Additional `conventional-changelog-parser` options that will overwrite ones loaded by `preset` or `config`.
+ * @param {Object} pluginConfig.writerOpts Additional `conventional-changelog-writer` options that will overwrite ones loaded by `preset` or `config`.
+ * @param {Object} context The semantic-release context.
+ * @param {Array<Object>} context.commits The commits to analyze.
+ * @param {Object} context.lastRelease The last release with `gitHead` corresponding to the commit hash used to make the last release and `gitTag` corresponding to the git tag associated with `gitHead`.
+ * @param {Object} context.nextRelease The next release with `gitHead` corresponding to the commit hash used to make the  release, the release `version` and `gitTag` corresponding to the git tag associated with `gitHead`.
+ * @param {Object} context.options.repositoryUrl The git repository URL.
  *
- * @returns {String} the changelog for all the commits in `options.commits`.
+ * @returns {String} The changelog for all the commits in `context.commits`.
  */
-async function releaseNotesGenerator(pluginConfig, {commits, lastRelease, nextRelease, options: {repositoryUrl}}) {
-  const {parserOpts, writerOpts} = await loadChangelogConfig(pluginConfig);
+async function releaseNotesGenerator(pluginConfig, context) {
+  const {
+    commits,
+    lastRelease,
+    nextRelease,
+    options: {repositoryUrl},
+  } = context;
+  const {parserOpts, writerOpts} = await loadChangelogConfig(pluginConfig, context);
 
   const {resource: hostname, port, name: repository, owner, protocols} = gitUrlParse(repositoryUrl);
   const protocol = protocols.includes('https') ? 'https' : protocols.includes('http') ? 'http' : 'https';
@@ -42,7 +48,7 @@ async function releaseNotesGenerator(pluginConfig, {commits, lastRelease, nextRe
   );
   const previousTag = lastRelease.gitTag || lastRelease.gitHead;
   const currentTag = nextRelease.gitTag || nextRelease.gitHead;
-  const context = {
+  const changelogContext = {
     version: nextRelease.version,
     host: url.format({protocol, hostname, port}),
     owner,
@@ -61,7 +67,7 @@ async function releaseNotesGenerator(pluginConfig, {commits, lastRelease, nextRe
   debug('previousTag: %o', previousTag);
   debug('currentTag: %o', currentTag);
 
-  return getStream(intoStream.obj(parsedCommits).pipe(writer(context, writerOpts)));
+  return getStream(intoStream.obj(parsedCommits).pipe(writer(changelogContext, writerOpts)));
 }
 
 module.exports = releaseNotesGenerator;

package/lib/load-changelog-config.js

@@ -5,20 +5,25 @@ const conventionalChangelogAngular = require('conventional-changelog-angular');
 /**
  * Load `conventional-changelog-parser` options. Handle presets that return either a `Promise<Array>` or a `Promise<Function>`.
  *
- * @param {Object} preset conventional-changelog preset ('angular', 'atom', 'codemirror', 'ember', 'eslint', 'express', 'jquery', 'jscs', 'jshint')
- * @param {string} config requierable npm package with a custom conventional-changelog preset
- * @param {Object} parserOpts additionnal `conventional-changelog-parser` options that will overwrite ones loaded by `preset` or `config`.
- * @param {Object} writerOpts additionnal `conventional-changelog-writer` options that will overwrite ones loaded by `preset` or `config`.
+ * @param {Object} pluginConfig The plugin configuration.
+ * @param {Object} pluginConfig.preset conventional-changelog preset ('angular', 'atom', 'codemirror', 'ember', 'eslint', 'express', 'jquery', 'jscs', 'jshint')
+ * @param {string} pluginConfig.config Requierable npm package with a custom conventional-changelog preset
+ * @param {Object} pluginConfig.parserOpts Additionnal `conventional-changelog-parser` options that will overwrite ones loaded by `preset` or `config`.
+ * @param {Object} pluginConfig.writerOpts Additionnal `conventional-changelog-writer` options that will overwrite ones loaded by `preset` or `config`.
+ * @param {Object} context The semantic-release context.
+ * @param {Array<Object>} context.commits The commits to analyze.
+ * @param {String} context.cwd The current working directory.
+ *
  * @return {Promise<Object>} a `Promise` that resolve to the `conventional-changelog-core` config.
  */
-module.exports = async ({preset, config, parserOpts, writerOpts}) => {
+module.exports = async ({preset, config, parserOpts, writerOpts}, {cwd}) => {
   let loadedConfig;
 
   if (preset) {
     const presetPackage = `conventional-changelog-${preset.toLowerCase()}`;
-    loadedConfig = importFrom.silent(__dirname, presetPackage) || importFrom(process.cwd(), presetPackage);
+    loadedConfig = importFrom.silent(__dirname, presetPackage) || importFrom(cwd, presetPackage);
   } else if (config) {
-    loadedConfig = importFrom.silent(__dirname, config) || importFrom(process.cwd(), config);
+    loadedConfig = importFrom.silent(__dirname, config) || importFrom(cwd, config);
   } else {
     loadedConfig = conventionalChangelogAngular;
   }

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@semantic-release/release-notes-generator",
   "description": "Customizable release-notes-generator plugin for semantic-release",
-  "version": "6.1.1",
+  "version": "7.0.0",
   "author": "Pierre Vanduynslager (https://twitter.com/@pvdlg_)",
   "bugs": {
     "url": "https://github.com/semantic-release/release-notes-generator/issues"
@@ -74,6 +74,9 @@
     ],
     "all": true
   },
+  "peerDependencies": {
+    "semantic-release": ">=15.8.0 <16.0.0"
+  },
   "prettier": {
     "printWidth": 120,
     "trailingComma": "es5"