xtra-ui-tag
v1.0.1
Published
A script that can be used to automatically tag packages in a continuous integration pipeline.
Downloads
4
Maintainers
Readme
xtra-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 xtra-ui-tag xtra-ui-tag -b <branch-name> -s <tag-suffix>
The
root
directory assumes apackage.json
and aCHANGELOG.md
are placed within the same folder.
Available options
The following table list out some options for the xtra-ui-tag
command. All these options can be configured:
| Option | Description | Default |
| ------ | ---------------------- | ------- |
| -b
| The branch you are on. | dev |
| -s
| 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
).