ump 3.3.0 → 3.4.0

package/README.md

@@ -21,12 +21,14 @@ For programmatic use (i.e. requiring it as a module in a node.js script), instal
   * `-m`, `--message`:      Message to be used for the commit and tag when `-r` or `-p` is set. Default: Release %s
   * `-r`, `--release`:      If set, runs `git add` and `git commit` for the bumped files and pushes a tagged release.
   * `-p`, `--publish`:      If set, automatically runs with the `--release` flag and then publishes the release to npm.
+  * `-a`, `--autostash`:    Default: `true`. Whether to use the `--autostash` flag when running `git pull`
+  * `-x`, `--skip-pull`:    If set, skips executing the initial git pull command during a release/publish task. USE WITH CAUTION.
   * `-d`, `--debug`:        If set, ump will run in debug mode, outputting a json file instead of doing something
   * `-h`, `--help`:         Shows help information on the command line
 
 ## Module Usage
 
-The only required option is `files`, which takes an array of files. All other options are the same as the command-line long-hand options: `message, release, publish, debug` (not `help`).
+The only required option is `files`, which takes an array of files. All other options are the same as the command-line *long-hand* options — `message, release, publish, debug` (not `help`). Note: the `skip-pull` option can be written as either kebab case (`skip-pull`) or camel case (`skipPull`).
 
 ```js
 import ump from 'ump';

package/lib/commands.js

@@ -27,6 +27,16 @@ const commands = {
   gitPull: function gitPull(opts) {
     // Need to pull before mucking with files, so we can stop it if git branch isn't clean.
     // Otherwise files will be bumped and committed but not pushed and things will get messed up.
+    // However, if the user is SURE this task can be skipped, the option is available
+
+    if (opts.skipPull) {
+      return {
+        log: '',
+        cmd: function() {
+          log.color('SKIPPED git pull', 'yellow');
+        },
+      };
+    }
     // **We can autostash on pull because we handle existence of uncommitted files later
     const pull = opts.autostash ? 'git pull --autostash' : 'git pull';
 

package/lib/config.js

@@ -17,6 +17,7 @@ const config = {
     regexReplace: '(?:[0-9]+\\.){2}[0-9]+[0-9a-zA-Z\\-_\\+\\.]*',
     regexFlags: 'g',
     autostash: true,
+    skipPull: false,
   },
 
   messages: {
@@ -89,17 +90,23 @@ Object.assign(config, {
       description: 'If set, automatically runs with the `--release` flag and then publishes the release to npm.',
       type: 'boolean',
     },
-    d: {
-      alias: 'debug',
-      description: 'If set, ump will run in debug mode, outputting a json file instead of doing something',
-      type: 'boolean',
-    },
     a: {
       alias: 'autostash',
       description: 'Whether to use the --autostash flag when running `git pull`',
       type: 'boolean',
       default: true,
     },
+    x: {
+      alias: 'skip-pull',
+      description: 'If set, skips executing the initial git pull command during a release/publish task. USE WITH CAUTION.',
+      type: 'boolean',
+      default: false,
+    },
+    d: {
+      alias: 'debug',
+      description: 'If set, ump will run in debug mode, outputting a json file instead of doing something',
+      type: 'boolean',
+    },
     extras: {
       description: 'Array of objects. ONLY AVAILABLE VIA .umprc OR when using ump() AS MODULE. Props: file, prefix (optional regex string), replaced (optional regex string), flags (optional). See https://github.com/kswedberg/ump/blob/master/README.md for more info.',
     },

package/lib/utils.js

@@ -209,6 +209,7 @@ const utils = {
     opts.files = utils.getFiles(opts.files);
     opts.extraFiles = utils.getFiles(opts.extras || []);
     opts.sourceFile = opts.files[0];
+    opts.skipPull = opts.skipPull || opts['skip-pull'];
 
     // opts.publish always implies opts.release as well (git push && git push --tags)
     if (opts.publish) {

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "ump",
   "title": "ump",
-  "version": "3.3.0",
+  "version": "3.4.0",
   "description": "Bump without the B",
   "scripts": {
     "test": "npm run test:clean && npm run test:pre && npm run test:run",

package/ump.js

@@ -44,7 +44,9 @@ const ump = async function(options) {
 
   if (opts.release) {
     // opts.dirty = commands.commitDirty(opts);
+
     // gitPull needs to happen first, so we don't update files when we can't complete things
+    // The skipPull option is available if we are SURE we don't need to pull
     sequence.unshift(commands.gitPull(opts));
     sequence.push(commands.gitRelease(opts));
   }