SDLC Vitech

Pipelines Helpers

• Usage
• Commands

Usage

$ npm install -g @sdlc.vitechteam/sdlc-pipeline-helper
$ sdlcpipelinehelper COMMAND
running command...
$ sdlcpipelinehelper (-v|--version|version)
@sdlc.vitechteam/sdlc-pipeline-helper/0.0.20 linux-x64 node-v14.19.2
$ sdlcpipelinehelper --help [COMMAND]
USAGE
  $ sdlcpipelinehelper COMMAND
...

Commands

• sdlcpipelinehelper check-publish
• sdlcpipelinehelper cucumber-publish
• sdlcpipelinehelper help [COMMAND]
• sdlcpipelinehelper junit-report-publish
• sdlcpipelinehelper sarif-publish

sdlcpipelinehelper check-publish

describe the command here

USAGE
  $ sdlcpipelinehelper check-publish

OPTIONS
  -h, --help                         show CLI help
  --appId=appId                      GitHub application id. Optionally use GH_APP_ID environment variable

  --checkConclusion=checkConclusion  Can be one of action_required, cancelled, failure, neutral, success, skipped,
                                     stale, or timed_out.
                                     When the conclusion is action_required, additional details should be
                                     provided on the site specified by details_url.

  --checkName=checkName              (required) check name

  --checkStatus=checkStatus          [default: completed] check status: queued, in_progress, or completed

  --commit=commit                    (required) commit SHA

  --detailsUrl=detailsUrl            Details URL about build. In our case link to Tekton dashboard.

  --installationId=installationId    GitHub application installationId. Optionally use GH_APP_INSTALLATION_ID
                                     environment variable

  --privateKey=privateKey            GitHub application primate key. Optionally use GH_APP_PRIVATE_KEY environment
                                     variable

  --repoName=repoName                (required) Git repository name

  --repoOwner=repoOwner              (required) Git repository owner

  --summary=summary                  (required) check summary

  --title=title                      (required) check title

See code: src/commands/check-publish.ts

sdlcpipelinehelper cucumber-publish

describe the command here

USAGE
  $ sdlcpipelinehelper cucumber-publish

OPTIONS
  -f, --reportPath=reportPath        [default: **/cucumber_report.json] report paths like: **/cucumber_report.json
  -h, --help                         show CLI help
  --appId=appId                      GitHub application id. Optionally use GH_APP_ID environment variable

  --checkConclusion=checkConclusion  Can be one of action_required, cancelled, failure, neutral, success, skipped,
                                     stale, or timed_out.
                                     When the conclusion is action_required, additional details should be
                                     provided on the site specified by details_url.

  --checkName=checkName              (required) Check Name

  --checkStatus=checkStatus          [default: completed] check status: queued, in_progress, or completed

  --commit=commit                    (required) commit SHA

  --detailsUrl=detailsUrl            Details URL about build. In our case link to Tekton dashboard.

  --installationId=installationId    GitHub application installationId. Optionally use GH_APP_INSTALLATION_ID
                                     environment variable

  --privateKey=privateKey            GitHub application primate key. Optionally use GH_APP_PRIVATE_KEY environment
                                     variable

  --repoFolderName=repoFolderName    [default: source] repository folder name

  --repoName=repoName                (required) Git repository name

  --repoOwner=repoOwner              (required) Git repository owner

  --sourceRootPath=sourceRootPath    [default: /workspace/source] source root path

See code: src/commands/cucumber-publish.ts

sdlcpipelinehelper help [COMMAND]

display help for sdlcpipelinehelper

USAGE
  $ sdlcpipelinehelper help [COMMAND]

ARGUMENTS
  COMMAND  command to show help for

OPTIONS
  --all  see all commands in CLI

See code: @oclif/plugin-help

sdlcpipelinehelper junit-report-publish

describe the command here

USAGE
  $ sdlcpipelinehelper junit-report-publish

OPTIONS
  -f, --reportPaths=reportPaths      (required) report paths like: **/test-results/**/TEST-*.xml
  -h, --help                         show CLI help
  --appId=appId                      GitHub application id. Optionally use GH_APP_ID environment variable

  --checkConclusion=checkConclusion  Can be one of action_required, cancelled, failure, neutral, success, skipped,
                                     stale, or timed_out.
                                     When the conclusion is action_required, additional details should be
                                     provided on the site specified by details_url.

  --checkName=checkName              (required) Check Name

  --checkStatus=checkStatus          [default: completed] check status: queued, in_progress, or completed

  --commit=commit                    (required) commit SHA

  --detailsUrl=detailsUrl            Details URL about build. In our case link to Tekton dashboard.

  --installationId=installationId    GitHub application installationId. Optionally use GH_APP_INSTALLATION_ID
                                     environment variable

  --privateKey=privateKey            GitHub application primate key. Optionally use GH_APP_PRIVATE_KEY environment
                                     variable

  --repoName=repoName                (required) Git repository name

  --repoOwner=repoOwner              (required) Git repository owner

EXAMPLE
  $ sdlcpipelinehelper junit-report-publish --reportPaths="**/test-results/**/TEST-*.xml" --commit="$PULL_PULL_SHA"

See code: src/commands/junit-report-publish.ts

sdlcpipelinehelper sarif-publish

Convert SARIF report into markdown format and publish it as Quality Check

USAGE
  $ sdlcpipelinehelper sarif-publish

OPTIONS
  -h, --help                         show CLI help
  --appId=appId                      GitHub application id. Optionally use GH_APP_ID environment variable

  --checkConclusion=checkConclusion  Can be one of action_required, cancelled, failure, neutral, success, skipped,
                                     stale, or timed_out.
                                     When the conclusion is action_required, additional details should be
                                     provided on the site specified by details_url.

  --checkName=checkName              (required) check name

  --checkStatus=checkStatus          [default: completed] check status: queued, in_progress, or completed

  --commit=commit                    (required) commit SHA

  --detailsUrl=detailsUrl            Details URL about build. In our case link to Tekton dashboard.

  --installationId=installationId    GitHub application installationId. Optionally use GH_APP_INSTALLATION_ID
                                     environment variable

  --privateKey=privateKey            GitHub application primate key. Optionally use GH_APP_PRIVATE_KEY environment
                                     variable

  --repoName=repoName                (required) Git repository name

  --repoOwner=repoOwner              (required) Git repository owner

  --sourceRoot=sourceRoot            (required) sourceRoot DIR

See code: src/commands/sarif-publish.ts