nrdk
Prerequisites
- Setup yout git CLI so that credentials are being cached. You can use the
storeorcachecredential 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.119 linux-x64 node-v14.17.0
$ 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 COMMANDCommands
nrdk backlog:checkin
On a Feature Branch, pushes local changes to the remote repository, and creates or updates a pull request to merge it into the Release branch.
USAGE
$ nrdk backlog:checkin
EXAMPLES
# nrdk backlog:checkout <Jira issue ID>
# git add .
# git commit -m "[Jira Issue] Adding new feature"
# nrdk backlog:checkin
Creates a new pull request merging branch Feature/[Jira Issue] into Release/<Jira Issue's Release's RFC's ID>
# git branch // already on Feature/[Jira Issue]
# git add .
# git commit -m "[Jira Issue] Expanding on feature"
# nrdk backlog:checkin
Updates the existing pull request with the new commit(s).See code: src/commands/backlog/checkin.ts
nrdk backlog:checkout [ISSUE]
Given a Jira Issue, checks out a Git branch named Feature/[Jira Issue] to resolve that Issue.
USAGE
$ nrdk backlog:checkout [ISSUE]
ARGUMENTS
ISSUE Jira issue key (e.g.: WEBADE-123)
EXAMPLE
# nrdk backlog:checkout IRS-200
# git status
On branch IRS-200See code: src/commands/backlog/checkout.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.
Troubleshooting
Please see TROUBLESHOOTING.md.
Development
Please see DEVELOPER.md.
Contributing
Please see CONTRIBUTING.md.
Conduct
Please see CONDUCT.md.