nrdk

• Prerequisites
• Usage
• Commands

Prerequisites

• Setup yout git CLI so that credentials are being cached. You can use the store or cache credential helper. PS.: Jenkins will do that automatically for you when running within a jenkins job.

Usage

$ npm install -g @bcgov/nrdk
$ nrdk COMMAND
running command...
$ nrdk (-v|--version|version)
@bcgov/nrdk/0.1.0-rc.28 darwin-x64 node-v12.14.1
$ nrdk --help [COMMAND]
USAGE
  $ nrdk COMMAND
...

The CLI can also be run with npx:

$ npx @bcgov/nrdk (-v|--version|version)
$ npx @bcgov/nrdk --help [COMMAND]
USAGE
  $ nrdk COMMAND

Commands

• nrdk build
• nrdk clean
• nrdk deploy
• nrdk functionaltest
• nrdk help [COMMAND]
• nrdk on:jira.issue

nrdk build

describe the command here

USAGE
  $ nrdk build

OPTIONS
  -b, --git.branch.name=git.branch.name  GIT local branch name
  --dev-mode                             Developer Mode (local)
  --env=env                              Environment
  --git.branch.merge=git.branch.merge    GIT remote branch name
  --git.change.target=git.change.target  Target branch of the pull request (env:CHANGE_TARGET)
  --git.remote.name=git.remote.name      [default: origin] GIT remote name
  --git.remote.url=git.remote.url        GIT remote URL
  --pr=pr                                Pull Request number

See code: src/commands/build.ts

nrdk clean

describe the command here

USAGE
  $ nrdk clean

OPTIONS
  -b, --git.branch.name=git.branch.name  GIT local branch name
  --env=env                              Environment
  --git.branch.merge=git.branch.merge    GIT remote branch name
  --git.remote.name=git.remote.name      [default: origin] GIT remote name
  --git.remote.url=git.remote.url        GIT remote URL
  --pr=pr                                Pull Request number

See code: src/commands/clean.ts

nrdk deploy

describe the command here

USAGE
  $ nrdk deploy

OPTIONS
  -b, --git.branch.name=git.branch.name  GIT local branch name
  --env=env                              Environment
  --git.branch.merge=git.branch.merge    GIT remote branch name
  --git.remote.name=git.remote.name      [default: origin] GIT remote name
  --git.remote.url=git.remote.url        GIT remote URL
  --pr=pr                                Pull Request number

See code: src/commands/deploy.ts

nrdk functionaltest

command to run functional tests for projects

USAGE
  $ nrdk functionaltest

OPTIONS
  -b, --git.branch.name=git.branch.name  GIT local branch name
  --env=env                              Environment
  --git.branch.merge=git.branch.merge    GIT remote branch name
  --git.remote.name=git.remote.name      [default: origin] GIT remote name
  --git.remote.url=git.remote.url        GIT remote URL
  --pr=pr                                Pull Request number

See code: src/commands/functionaltest.ts

nrdk help [COMMAND]

display help for nrdk

USAGE
  $ nrdk help [COMMAND]

ARGUMENTS
  COMMAND  command to show help for

OPTIONS
  --all  see all commands in CLI

See code: @oclif/plugin-help

nrdk on:jira.issue

describe the command here

USAGE
  $ nrdk on:jira.issue

OPTIONS
  -b, --git.branch.name=git.branch.name  GIT local branch name
  --env=env                              Environment
  --git.branch.merge=git.branch.merge    GIT remote branch name
  --git.remote.name=git.remote.name      [default: origin] GIT remote name
  --git.remote.url=git.remote.url        GIT remote URL
  --pr=pr                                Pull Request number

See code: src/commands/on/jira.issue.ts