github.com/jaylevin/jenkins-library@v1.230.4/resources/metadata/githubPublishRelease.yaml (about)

     1  metadata:
     2    name: githubPublishRelease
     3    description: Publish a release in GitHub
     4    longDescription: |
     5      This step creates a tag in your GitHub repository together with a release.
     6      The release can be filled with text plus additional information like:
     7  
     8      * Closed pull request since last release
     9      * Closed issues since last release
    10      * Link to delta information showing all commits since last release
    11  
    12      The result looks like
    13  
    14      ![Example release](../images/githubRelease.png)
    15  spec:
    16    inputs:
    17      secrets:
    18        - name: githubTokenCredentialsId
    19          description: Jenkins 'Secret text' credentials ID containing token to authenticate to GitHub.
    20          type: jenkins
    21      params:
    22        - name: addClosedIssues
    23          description: "If set to `true`, closed issues and merged pull-requests since the last release will added below the `releaseBodyHeader`"
    24          scope:
    25            - PARAMETERS
    26            - STAGES
    27            - STEPS
    28          type: bool
    29          default: false
    30        - name: addDeltaToLastRelease
    31          description: "If set to `true`, a link will be added to the release information that brings up all commits since the last release."
    32          scope:
    33            - PARAMETERS
    34            - STAGES
    35            - STEPS
    36          type: bool
    37          default: false
    38        - name: apiUrl
    39          aliases:
    40            - name: githubApiUrl
    41          description: Set the GitHub API url.
    42          scope:
    43            - GENERAL
    44            - PARAMETERS
    45            - STAGES
    46            - STEPS
    47          type: string
    48          default: https://api.github.com
    49          mandatory: true
    50        - name: assetPath
    51          description: Path to a release asset which should be uploaded to the list of release assets.
    52          scope:
    53            - PARAMETERS
    54            - STAGES
    55            - STEPS
    56          type: string
    57        - name: assetPathList
    58          description: List of paths to a release asset which should be uploaded to the list of release assets.
    59          scope:
    60            - PARAMETERS
    61            - STAGES
    62            - STEPS
    63          type: "[]string"
    64        - name: commitish
    65          description: "Target git commitish for the release"
    66          scope:
    67            - PARAMETERS
    68            - STAGES
    69            - STEPS
    70          type: string
    71          default: "master"
    72        - name: excludeLabels
    73          description: "Allows to exclude issues with dedicated list of labels."
    74          scope:
    75            - PARAMETERS
    76            - STAGES
    77            - STEPS
    78          type: "[]string"
    79        - name: labels
    80          description: "Labels to include in issue search."
    81          scope:
    82            - PARAMETERS
    83            - STAGES
    84            - STEPS
    85          type: "[]string"
    86        - name: owner
    87          aliases:
    88            - name: githubOrg
    89          description: Name of the GitHub organization.
    90          resourceRef:
    91            - name: commonPipelineEnvironment
    92              param: github/owner
    93          scope:
    94            - PARAMETERS
    95            - STAGES
    96            - STEPS
    97          type: string
    98          mandatory: true
    99        - name: preRelease
   100          description: "If set to `true` the release will be marked as Pre-release."
   101          scope:
   102            - PARAMETERS
   103            - STAGES
   104            - STEPS
   105          type: bool
   106          default: false
   107        - name: releaseBodyHeader
   108          description: Content which will appear for the release.
   109          scope:
   110            - PARAMETERS
   111            - STAGES
   112            - STEPS
   113          type: string
   114        - name: repository
   115          aliases:
   116            - name: githubRepo
   117          description: Name of the GitHub repository.
   118          resourceRef:
   119            - name: commonPipelineEnvironment
   120              param: github/repository
   121          scope:
   122            - PARAMETERS
   123            - STAGES
   124            - STEPS
   125          type: string
   126          mandatory: true
   127        - name: serverUrl
   128          aliases:
   129            - name: githubServerUrl
   130          description: "GitHub server url for end-user access."
   131          scope:
   132            - GENERAL
   133            - PARAMETERS
   134            - STAGES
   135            - STEPS
   136          type: string
   137          default: https://github.com
   138          mandatory: true
   139        - name: tagPrefix
   140          type: string
   141          description: "Defines a prefix to be added to the tag."
   142          scope:
   143            - PARAMETERS
   144            - STAGES
   145            - STEPS
   146          default: ""
   147        - name: token
   148          aliases:
   149            - name: githubToken
   150            - name: access_token
   151          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"
   152          scope:
   153            - GENERAL
   154            - PARAMETERS
   155            - STAGES
   156            - STEPS
   157          type: string
   158          mandatory: true
   159          secret: true
   160          resourceRef:
   161            - name: githubTokenCredentialsId
   162              type: secret
   163            - type: vaultSecret
   164              default: github
   165              name: githubVaultSecretName
   166        - name: uploadUrl
   167          aliases:
   168            - name: githubUploadUrl
   169          description: Set the GitHub API url.
   170          scope:
   171            - GENERAL
   172            - PARAMETERS
   173            - STAGES
   174            - STEPS
   175          type: string
   176          default: https://uploads.github.com
   177          mandatory: true
   178        - name: version
   179          description: "Define the version number which will be written as tag as well as release name."
   180          resourceRef:
   181            - name: commonPipelineEnvironment
   182              param: artifactVersion
   183          scope:
   184            - PARAMETERS
   185            - STAGES
   186            - STEPS
   187          type: string
   188          mandatory: true