KGrid Release CLI
This CLI will help you trigger a Release of the KGrid components.
Getting Started
- Get a Circle CI a personal api token
npm install -g @kgrid/release-cli
- Run
export CIRCLECI_TOKEN=#### && kgrid-release
Using the CLI
- Choose the component
- Adapter is sub module so if Adapter you have to say api or javascript otherwise just press enter
- The release version #.#.# for releases #.#.#-rc# for release candidates. This will used to tag the GitHub repository. For maven projects this sets the version
- The development version will be #.#.#-SNAPSHOT, used for maven projects can be innored for KO releases.
- If it is Pre Release type Y defaults to N
Review the additional [#note]
Will kick off Circle CI build.
_ ______ _ _ ____ _ ____ _ ___
| |/ / ___|_ __(_) __| | | _ \ ___| | ___ __ _ ___ ___ / ___| | |_ _|
| ' / | _| '__| |/ _` | | |_) / _ \ |/ _ \/ _` / __|/ _ \ | | | | | |
| . \ |_| | | | | (_| | | _ < __/ | __/ (_| \__ \ __/ | |___| |___ | |
|_|\_\____|_| |_|\__,_| |_| \_\___|_|\___|\__,_|___/\___| \____|_____|___|
? What KGrid Component are you Releasing? (Use arrow keys)
❯ Activator
Adapter
Library
Play
Shelf
Here is an example of final screen
_ ______ _ _ ____ _ ____ _ ___
| |/ / ___|_ __(_) __| | | _ \ ___| | ___ __ _ ___ ___ / ___| | |_ _|
| ' / | _| '__| |/ _` | | |_) / _ \ |/ _ \/ _` / __|/ _ \ | | | | | |
| . \ |_| | | | | (_| | | _ < __/ | __/ (_| \__ \ __/ | |___| |___ | |
|_|\_\____|_| |_|\__,_| |_| \_\___|_|\___|\__,_|___/\___| \____|_____|___|
? What KGrid Component are you Releasing? Activator
? What branch (e.g. hotfix, feature or master)? master
? What is the Component Module (e.g. adapter-api or javascript-adapter or blank)?
? What is the Release Version (e.g. 1.0.3)? 1.0.1-rc3
? What is the Development Version (e.g 1.0.4-SNAPSHOT)? 1.0.1-SNAPSHOT
? Is this PreRelease? Yes
Build has started
~/kgrid-config/release/cli $
Issues
- Issues with executing
kgrid-release
once installed could be based on a few things- make sure it is global
npm list -g --depth=0
- run
npm bin -g
to global bin path.
- make sure it is global
Notes
-
Component Module is only need when releasing Adapters. The project consists of mmaven submodules and thus requires more information
-
The Demo components release process consists of updating the the GitHub pages. When releasing Demos you really only have to input a Release Version, it will be used to tag the repo.