veflow

Mercurial helper functions

Usage no npm install needed!

<script type="module">
  import veflow from 'https://cdn.skypack.dev/veflow';
</script>

README

VEFlow (for Mercurial)

GitHub: https://github.com/visualeyes/veflow

NPM: https://www.npmjs.com/package/veflow

build status

Requirements

Overview

A globally installable helper package which fills gaps in specific HG Flow use cases.

Installation

  1. Run npm i -g veflow
  2. In the project where you'll be using veflow, add a .veflow.json file for configuration, see the example below

Example .veflow.json

{
    "masterRepo": "master",
    "releasedBookmark": "current",
    "unreleasedOrderedBranches": [
        "release/2",
        "release/3"
    ]
}

Usage

Close

Replacement for hg flow finish, where hotfixed code is not merged into each unreleased branch.

veflow close [branch]

If you omit branch the currently updated branch will be assumed.

Effects:

  1. Pull from master repository
  2. Close branch (currently active if none specified)
  3. Merge down the tree, for example merge hotfix/123/321/213 into hotfix/123/321 then hotfix/123 etc.
  4. If hotfix, merge branch into configured releasedBookmark
  5. If release or hotfix, iterate through unreleasedOrderedBranches and merge into each of those.
  6. Merge into develop

Development

Tests

Jest is used for unit tests, you can run the tests by using npm run test