Skip to content

githubPublishRelease

Publish a release in GitHub

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

Name Mandatory Additional information
apiUrl yes
owner yes
repository yes
script yes Jenkins only reference to Jenkins main pipeline script
serverUrl yes
token yes Secret pass via ENV or Jenkins credentials (githubTokenCredentialsId)
uploadUrl yes
version yes
addClosedIssues no
addDeltaToLastRelease no
assetPath no
commitish no
excludeLabels no
labels no
preRelease no
releaseBodyHeader no
verbose no activates debug output

Details

addClosedIssues

If set to true, closed issues and merged pull-requests since the last release will added below the releaseBodyHeader

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

addDeltaToLastRelease

If set to true, a link will be added to the relese information that brings up all commits since the last release.

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

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

assetPath

Path to a release asset which should be uploaded to the list of release assets.

back to overview

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

commitish

Target git commitish for the release

back to overview

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

excludeLabels

Allows to exclude issues with dedicated list of labels.

back to overview

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

labels

Labels to include in issue search.

back to overview

Scope Details
Aliases -
Type []string
Mandatory no
Default $PIPER_labels (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

preRelease

If set to true the release will be marked as Pre-release.

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

releaseBodyHeader

Content which will appear for the release.

back to overview

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

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

serverUrl

GitHub server url for end-user access.

back to overview

Scope Details
Aliases githubServerUrl
Type string
Mandatory no
Default https://github.com
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
Type string
Mandatory yes
Default $PIPER_token (if set)
Secret yes
Configuration scope
  • ☒ parameter
  • ☒ general
  • ☒ steps
  • ☒ stages
Resource references Jenkins credential id:
  id: githubTokenCredentialsId
  reference to: ``

uploadUrl

Set the GitHub API url.

back to overview

Scope Details
Aliases githubUploadUrl
Type string
Mandatory no
Default https://uploads.github.com
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

version

Define the version number which will be written as tag as well as release name.

back to overview

Scope Details
Aliases -
Type string
Mandatory yes
Default $PIPER_version (if set)
Secret no
Configuration scope
  • ☒ parameter
  • ☐ general
  • ☒ steps
  • ☒ stages
Resource references commonPipelineEnvironment:
  reference to: artifactVersion

githubTokenCredentialsId

Jenkins-specific: Used for proper environment setup.

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 creates a tag in your GitHub repository together with a release. The release can be filled with text plus additional information like:

  • Closed pull request since last release
  • Closed issues since last release
  • Link to delta information showing all commits since last release

The result looks like

Example release

Usage

We recommend to define values of step parameters via config.yml file. In this case, calling the step is reduced to one simple line.
Calling the step can be done either via the Jenkins library step or on the command line.

Jenkins pipelines

githubPublishRelease script: this

Command line

piper githubPublishRelease

Example

Usage of pipeline step:

githubPublishRelease script: this, releaseBodyHeader: "**This is the latest success!**<br />"