feat: add logs about prepare, publish, success and fail plugins skipped in dry-run mode

lib/definitions/plugins.js

@@ -7,11 +7,13 @@ const {RELEASE_TYPE, RELEASE_NOTES_SEPARATOR} = require('./constants');
 module.exports = {
   verifyConditions: {
     required: false,
+    dryRun: true,
     pipelineConfig: () => ({settleAll: true}),
   },
   analyzeCommits: {
     default: ['@semantic-release/commit-analyzer'],
     required: true,
+    dryRun: true,
     outputValidator: output => !output || RELEASE_TYPE.includes(output),
     preprocess: ({commits, ...inputs}) => ({
       ...inputs,
@@ -27,10 +29,12 @@ module.exports = {
   },
   verifyRelease: {
     required: false,
+    dryRun: true,
     pipelineConfig: () => ({settleAll: true}),
   },
   generateNotes: {
     required: false,
+    dryRun: true,
     outputValidator: output => !output || isString(output),
     pipelineConfig: () => ({
       getNextInput: ({nextRelease, ...context}, notes) => ({
@@ -45,6 +49,7 @@ module.exports = {
   },
   prepare: {
     required: false,
+    dryRun: false,
     pipelineConfig: ({generateNotes}) => ({
       getNextInput: async context => {
         const newGitHead = await gitHead({cwd: context.cwd});
@@ -61,6 +66,7 @@ module.exports = {
   },
   publish: {
     required: false,
+    dryRun: false,
     outputValidator: output => !output || isPlainObject(output),
     pipelineConfig: () => ({
       // Add `nextRelease` and plugin properties to published release
@@ -73,11 +79,13 @@ module.exports = {
   },
   success: {
     required: false,
+    dryRun: false,
     pipelineConfig: () => ({settleAll: true}),
     preprocess: ({releases, env, ...inputs}) => ({...inputs, env, releases: hideSensitiveValues(env, releases)}),
   },
   fail: {
     required: false,
+    dryRun: false,
     pipelineConfig: () => ({settleAll: true}),
     preprocess: ({errors, env, ...inputs}) => ({...inputs, env, errors: hideSensitiveValues(env, errors)}),
   },

lib/plugins/normalize.js

@@ -27,20 +27,23 @@ module.exports = (context, type, pluginOpt, pluginsPath) => {
   }
 
   const validator = async input => {
-    const {outputValidator} = PLUGINS_DEFINITIONS[type] || {};
+    const {dryRun, outputValidator} = PLUGINS_DEFINITIONS[type] || {};
     try {
-      logger.log(`Start step "${type}" of plugin "${pluginName}"`);
-      const result = await func({
-        ...cloneDeep(omit(input, ['stdout', 'stderr', 'logger'])),
-        stdout,
-        stderr,
-        logger: logger.scope(logger.scopeName, pluginName),
-      });
-      if (outputValidator && !outputValidator(result)) {
-        throw getError(`E${type.toUpperCase()}OUTPUT`, {result, pluginName});
+      if (!input.options.dryRun || dryRun) {
+        logger.log(`Start step "${type}" of plugin "${pluginName}"`);
+        const result = await func({
+          ...cloneDeep(omit(input, ['stdout', 'stderr', 'logger'])),
+          stdout,
+          stderr,
+          logger: logger.scope(logger.scopeName, pluginName),
+        });
+        if (outputValidator && !outputValidator(result)) {
+          throw getError(`E${type.toUpperCase()}OUTPUT`, {result, pluginName});
+        }
+        logger.success(`Completed step "${type}" of plugin "${pluginName}"`);
+        return result;
       }
-      logger.success(`Completed step "${type}" of plugin "${pluginName}"`);
-      return result;
+      logger.warn(`Skip step "${type}" of plugin "${pluginName}" in dry-run mode`);
     } catch (error) {
       logger.error(`Failed step "${type}" of plugin "${pluginName}"`);
       extractErrors(error).forEach(err => Object.assign(err, {pluginName}));