2019-12-16 18:34:12 +02:00
metadata :
name : githubCreatePullRequest
description : Create a pull request on GitHub
longDescription : |
This step allows you to create a pull request on Github.
It can for example be used for GitOps scenarios or for scenarios where you want to have a manual confirmation step which is delegated to a GitHub pull request.
spec :
inputs :
secrets :
2020-08-31 16:10:28 +02:00
- name : githubTokenCredentialsId
description : Jenkins 'Secret text' credentials ID containing token to authenticate to GitHub.
type : jenkins
2019-12-16 18:34:12 +02:00
params :
2020-08-31 16:10:28 +02:00
- name : assignees
description : Login names of users to which the PR should be assigned to.
scope :
- PARAMETERS
- STAGES
- STEPS
type : "[]string"
- name : base
description : The name of the branch you want the changes pulled into.
scope :
- PARAMETERS
- STAGES
- STEPS
type : string
mandatory : true
- name : body
description : The description text of the pull request in markdown format.
scope :
- PARAMETERS
- STAGES
- STEPS
type : string
mandatory : true
- name : apiUrl
aliases :
- name : githubApiUrl
description : Set the GitHub API url.
scope :
- GENERAL
- PARAMETERS
- STAGES
- STEPS
type : string
default : https://api.github.com
mandatory : true
- name : head
description : The name of the branch where your changes are implemented.
scope :
- PARAMETERS
- STAGES
- STEPS
type : string
mandatory : true
- name : owner
aliases :
- name : githubOrg
2020-09-14 12:05:12 +02:00
description : Name of the GitHub organization.
2020-09-15 17:50:55 +02:00
resourceRef :
- name : commonPipelineEnvironment
param : github/owner
2020-08-31 16:10:28 +02:00
scope :
- PARAMETERS
- STAGES
- STEPS
type : string
mandatory : true
- name : repository
aliases :
- name : githubRepo
2020-09-14 12:05:12 +02:00
description : Name of the GitHub repository.
2020-09-15 17:50:55 +02:00
resourceRef :
- name : commonPipelineEnvironment
param : github/repository
2020-08-31 16:10:28 +02:00
scope :
- PARAMETERS
- STAGES
- STEPS
type : string
mandatory : true
- name : serverUrl
aliases :
- name : githubServerUrl
description : GitHub server url for end-user access.
scope :
- GENERAL
- PARAMETERS
- STAGES
- STEPS
type : string
default : https://github.com
mandatory : true
- name : title
description : Title of the pull request.
scope :
- PARAMETERS
- STAGES
- STEPS
type : string
mandatory : true
- name : token
aliases :
- name : githubToken
2021-01-27 13:58:47 +02:00
- name : access_token
2020-08-31 16:10:28 +02:00
description : GitHub personal access token as per https://help.github.com/en/github/authenticating-to-github/creating-a-personal-access-token-for-the-command-line
scope :
- GENERAL
- PARAMETERS
- STAGES
- STEPS
type : string
mandatory : true
secret : true
resourceRef :
- name : githubTokenCredentialsId
type : secret
2020-12-22 18:57:11 +02:00
- type : vaultSecret
paths :
- $(vaultPath)/github
- $(vaultBasePath)/$(vaultPipelineName)/github
- $(vaultBasePath)/GROUP-SECRETS/github
2020-08-31 16:10:28 +02:00
- name : labels
description : Labels to be added to the pull request.
scope :
- PARAMETERS
- STAGES
- STEPS
type : "[]string"