npm package: @sdlc.vitechteam/sdlc-pipeline-helper
Description: SDLC Pipelines Helper
Author: serhiykrupka
Latest version: 0.0.20

[SDLC Vitech](https://vitech-team.github.io/SDLC/)
===================

Pipelines Helpers

[![oclif](https://img.shields.io/badge/cli-oclif-brightgreen.svg)](https://oclif.io)
[![Version](https://img.shields.io/npm/v/@sdlc.vitechteam/sdlc-pipeline-helper.svg)](https://npmjs.org/package/@sdlc.vitechteam/sdlc-pipeline-helper)
[![Downloads/week](https://img.shields.io/npm/dw/@sdlc.vitechteam/sdlc-pipeline-helper.svg)](https://npmjs.org/package/@sdlc.vitechteam/sdlc-pipeline-helper)
[![License](https://img.shields.io/npm/l/sdlc.vitechteam.com.svg)](https://github.com/vitech-team/pipeline-helper/blob/master/package.json)

<!-- toc -->
* [Usage](#usage)
* [Commands](#commands)
<!-- tocstop -->
# Usage
<!-- usage -->
```sh-session
$ 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
...
```
<!-- usagestop -->
# Commands
<!-- commands -->
* [`sdlcpipelinehelper check-publish`](#sdlcpipelinehelper-check-publish)
* [`sdlcpipelinehelper cucumber-publish`](#sdlcpipelinehelper-cucumber-publish)
* [`sdlcpipelinehelper help [COMMAND]`](#sdlcpipelinehelper-help-command)
* [`sdlcpipelinehelper junit-report-publish`](#sdlcpipelinehelper-junit-report-publish)
* [`sdlcpipelinehelper sarif-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](https://github.com/vitech-team-sdlc/sdlc-pipeline-helper/blob/v0.0.20/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](https://github.com/vitech-team-sdlc/sdlc-pipeline-helper/blob/v0.0.20/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](https://github.com/oclif/plugin-help/blob/v3.2.3/src/commands/help.ts)_

## `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](https://github.com/vitech-team-sdlc/sdlc-pipeline-helper/blob/v0.0.20/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](https://github.com/vitech-team-sdlc/sdlc-pipeline-helper/blob/v0.0.20/src/commands/sarif-publish.ts)_
<!-- commandsstop -->