Configuration

Add the following scripts to your package.json

"release": "node node_modules/@vida-global/release/scripts/release.js",
"develop": "node node_modules/@vida-global/release/scripts/release.js develop"

Release Management

The release script provides serves two purposes, version management and production release management.

Version Management

npm run release increment <major,minor,point>

Running this command will find the current main or master branch on your remote repo, search for the highest remote version, create a new release branch with the incremented version, and update the version in package.json

Production Release Management

npm run release production [version]

Running this command will find the current highest version on the remote repo, or the one specified by the version option, and replace release/production with that branch.

Example

Given a current highest version of release/1.5.3

Increment point version

npm run release increment point

This will create a new branch of origin/master named release/1.6.0 and will update package.json to use 1.6.0 as the "version."

Release

npm run release production

This will replace release/production with a branch of release/1.6.0

Rollback a release

npm run release production

This will replace release/production with a branch of release/1.6.0

Development

npm run develop -- this is my new branch -i123

This will offer to create a new branch feature/123/<YOUR_INITIALS>/this-is-my-new-branch

Options

-i --issue (required)

Provide the issue number this branch is associated with

-t --type (optional)

By default, the script creates a branch of type feature. Using the -t option, you can create a branch of type bugfix, chore, feature, hotfix, or refactor

-s --source (optional)

By default, this script creates a branch of origin/master. By specifying the -s option and providing a branch name, you will create a branch from the provided source.