blui-tag

@brightlayer-ui/tag

This Command Line tool is a utility for automatically creating tags and github releases through a continuous integration pipeline. Given a package.json and a CHANGELOG.md, it will parse out the latest release notes and publish the latest release.

Prerequisites

In order to use this utility you must have the following installed:

• NodeJS 12+
• npm
• Github CLI

Usage

You can use this package by running it in the root directory of your project with npx (recommended):

npx -p @brightlayer-ui/tag blui-tag -b <branch-name> -s <tag-suffix>

The root directory assumes a package.json and a CHANGELOG.md are placed within the same folder.

Available options

The following table list out some options for the blui-tag command. All these options can be configured:

Option	Description
-b	(default: dev) The branch you are on.
-s	(default: '') The tag suffix.

The branch flag is used to determine whether a package should be tagged. Tags may only be created for the master branch (-b master).