githubCreateIssue¶

Create a new GitHub issue.

Prerequisites¶

You need to create a personal access token within GitHub and add this to the Jenkins credentials store.

Please see GitHub documentation for details about creating the personal access token.

Parameters¶

Overview - Step¶

Name	Mandatory	Additional information
owner	yes
repository	yes
script	(yes)	reference to Jenkins main pipeline script
title	yes
token	(yes)	pass via ENV, Vault or Jenkins credentials (`githubTokenCredentialsId`)
apiUrl	no
assignees	no
body	no
bodyFilePath	no
updateExisting	no
verbose	no	activates debug output

Overview - Execution Environment¶

Orchestrator-specific only

These parameters are relevant for orchestrator usage and not considered when using the command line option.

Name	Mandatory	Additional information

Details¶

apiUrl¶

Set the GitHub API url.

back to overview

Scope	Details
Aliases	`githubApiUrl`
Type	`string`
Mandatory	no
Default	`https://api.github.com`
Secret	no
Configuration scope	☒ parameter ☒ general ☒ steps ☒ stages
Resource references	none

assignees¶

Defines the assignees for the Issue.

back to overview

Scope	Details
Aliases	-
Type	`[]string`
Mandatory	no
Default
Secret	no
Configuration scope	☒ parameter ☐ general ☒ steps ☒ stages
Resource references	none

body¶

Defines the content of the issue, e.g. using markdown syntax.

back to overview

Scope	Details
Aliases	-
Type	`string`
Mandatory	no
Default	`$PIPER_body` (if set)
Secret	no
Configuration scope	☒ parameter ☐ general ☒ steps ☒ stages
Resource references	none

bodyFilePath¶

Defines the path to a file containing the markdown content for the issue. This can be used instead of body

back to overview

Scope	Details
Aliases	-
Type	`string`
Mandatory	no
Default	`$PIPER_bodyFilePath` (if set)
Secret	no
Configuration scope	☒ parameter ☐ general ☒ steps ☒ stages
Resource references	none

owner¶

Name of the GitHub organization.

back to overview

Scope	Details
Aliases	`githubOrg`
Type	`string`
Mandatory	yes
Default	`$PIPER_owner` (if set)
Secret	no
Configuration scope	☒ parameter ☐ general ☒ steps ☒ stages
Resource references	commonPipelineEnvironment: reference to: `github/owner`

repository¶

Name of the GitHub repository.

back to overview

Scope	Details
Aliases	`githubRepo`
Type	`string`
Mandatory	yes
Default	`$PIPER_repository` (if set)
Secret	no
Configuration scope	☒ parameter ☐ general ☒ steps ☒ stages
Resource references	commonPipelineEnvironment: reference to: `github/repository`

script¶

Jenkins-specific: Used for proper environment setup.

The common script environment of the Jenkinsfile running. Typically the reference to the script calling the pipeline step is provided with the this parameter, as in script: this. This allows the function to access the commonPipelineEnvironment for retrieving, e.g. configuration parameters.

back to overview

Scope	Details
Aliases	-
Type	`Jenkins Script`
Mandatory	yes
Default
Secret	no
Configuration scope	☐ parameter ☐ general ☐ steps ☐ stages
Resource references	none

title¶

Defines the title for the Issue.

back to overview

Scope	Details
Aliases	-
Type	`string`
Mandatory	yes
Default	`$PIPER_title` (if set)
Secret	no
Configuration scope	☒ parameter ☐ general ☒ steps ☒ stages
Resource references	none

token¶

GitHub personal access token as per https://help.github.com/en/github/authenticating-to-github/creating-a-personal-access-token-for-the-command-line.

back to overview

Scope	Details
Aliases	- `githubToken` - `access_token`
Type	`string`
Mandatory	yes
Default	`$PIPER_token` (if set)
Secret	yes
Configuration scope	☒ parameter ☒ general ☒ steps ☒ stages
Resource references	Jenkins credential id: id: `githubTokenCredentialsId` Vault paths: `$(vaultPath)/github` `$(vaultBasePath)/$(vaultPipelineName)/github` `$(vaultBasePath)/GROUP-SECRETS/github`

updateExisting¶

Whether to update an existing open issue with the same title by adding a comment instead of creating a new one.

back to overview

Scope	Details
Aliases	-
Type	`bool`
Mandatory	no
Default	`false`
Possible values	- `true` - `false`
Secret	no
Configuration scope	☒ parameter ☐ general ☒ steps ☒ stages
Resource references	none

verbose¶

verbose output

back to overview

Scope	Details
Aliases	-
Type	`bool`
Mandatory	no
Default	`false`
Possible values	- `true` - `false`
Secret	no
Configuration scope	☒ parameter ☒ general ☒ steps ☒ stages
Resource references	none

githubTokenCredentialsId¶

Jenkins-specific: Used for proper environment setup. See using credentials for details.

Jenkins 'Secret text' credentials ID containing token to authenticate to GitHub.

back to overview

Scope	Details
Aliases	-
Type	`string`
Configuration scope	☒ parameter ☒ general ☒ steps ☒ stages

Description¶

This step allows you to create a new GitHub issue.

You will be able to use this step for example for regular jobs to report into your repository in case of new security findings.

Usage¶

We recommend to define values of step parameters via .pipeline/config.yml file.
In this case, calling the step is essentially reduced to defining the step name.
Calling the step can be done either in an orchestrator specific way (e.g. via a Jenkins library step) or on the command line.

Jenkins

library('piper-lib-os')

githubCreateIssue script: this

Command Line

piper githubCreateIssue