Add label to log messages when dry-run is enabled using bagofcli 2.4.1 .

CHANGELOG.md

@@ -7,6 +7,9 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 ## Unreleased
 
+### Added
+- Add label to log messages when dry-run is enabled
+
 ### Changed
 - Modify syntax for array sub-property following dot-prop 8.x upgrade
 

lib/release-schemes/rtk.js

@@ -36,13 +36,18 @@ class Rtk {
     const VersionSchemeClass = this.versionSchemes[versionSchemeName];
     this.versionScheme = new VersionSchemeClass(preReleaseVersion, opts.releaseIncrementType, opts.postReleaseIncrementType);
     this.scmScheme = this.scmSchemes[scmSchemeName];
+
+    this.logOpts = {}
+    if (opts.dryRun) {
+      this.logOpts['labels'] = ['dry run'];
+    }
   }
 
   pre(resources, opts, cb) {
 
     const self = this;
 
-    bag.logStepHeading('Executing pre step of rtk release scheme...');
+    bag.logStepHeading('Executing pre step of rtk release scheme...', self.logOpts);
 
     let tasks = [];
     let paths = [];
@@ -53,7 +58,7 @@ class Rtk {
           releaseVersion = stringFormat(resource.params.release_format, { version: releaseVersion });
         }
         const message = util.format('Setting release version %s on %s resource located at %s', releaseVersion, resource.type, resource.path);
-        bag.logStepItemSuccess(message);
+        bag.logStepItemSuccess(message, self.logOpts);
         self.resourceTypes[resource.type].setReleaseVersion(releaseVersion, resource, opts, cb);
       }
       tasks.push(resourceTask);
@@ -62,7 +67,7 @@ class Rtk {
 
     function scmTask(cb) {
       const message = util.format('Committing release version changes made to %s...', paths.join(', '));
-      bag.logStepItemSuccess(message);
+      bag.logStepItemSuccess(message, self.logOpts);
       self.scmScheme.saveChanges(util.format('Release version %s', self.versionScheme.getReleaseVersion()), paths, cb);
     }
 
@@ -78,13 +83,13 @@ class Rtk {
 
     const self = this;
 
-    bag.logStepHeading('Executing release step of rtk release scheme...');
+    bag.logStepHeading('Executing release step of rtk release scheme...', self.logOpts);
 
     function scmTask(cb) {
       // Use tagFormat option to format the version to be used as SCM tag
       const formattedVersion = stringFormat(opts.tagFormat, { version: self.versionScheme.getReleaseVersion() });
       const message = util.format('Adding release version tag %s ...', formattedVersion);
-      bag.logStepItemSuccess(message);
+      bag.logStepItemSuccess(message, self.logOpts);
       self.scmScheme.addVersion(formattedVersion, cb);
     }
 
@@ -101,15 +106,15 @@ class Rtk {
 
     const self = this;
 
-    bag.logStepHeading('Executing post step of rtk release scheme...');
+    bag.logStepHeading('Executing post step of rtk release scheme...', self.logOpts);
 
     let tasks = [];
     let paths = [];
     resources.forEach((resource) => {
       function resourceTask(cb) {
         const postReleaseVersion = resource.params && resource.params.post_release_value ? resource.params.post_release_value : self.versionScheme.getPostReleaseVersion();
         const message = util.format('Setting next pre-release version %s on %s resource located at %s', postReleaseVersion, resource.type, resource.path);
-        bag.logStepItemSuccess(message);
+        bag.logStepItemSuccess(message, self.logOpts);
         self.resourceTypes[resource.type].setPostReleaseVersion(postReleaseVersion, resource, opts, cb);
       }
       tasks.push(resourceTask);
@@ -118,7 +123,7 @@ class Rtk {
 
     function scmTask(cb) {
       const message = util.format('Committing next pre-release version changes made to %s...', paths.join(', '));
-      bag.logStepItemSuccess(message);
+      bag.logStepItemSuccess(message, self.logOpts);
       self.scmScheme.saveChanges(util.format('Bump up to next pre-release version %s', self.versionScheme.getPostReleaseVersion()), paths), cb;
     }