github.com/ouraigua/jenkins-library@v0.0.0-20231028010029-fbeaf2f3aa9b/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          resourceRef:
    73            - name: commonPipelineEnvironment
    74              param: git/headCommitId
    75        - name: excludeLabels
    76          description: "Allows to exclude issues with dedicated list of labels."
    77          scope:
    78            - PARAMETERS
    79            - STAGES
    80            - STEPS
    81          type: "[]string"
    82        - name: labels
    83          description: "Labels to include in issue search."
    84          scope:
    85            - PARAMETERS
    86            - STAGES
    87            - STEPS
    88          type: "[]string"
    89        - name: owner
    90          aliases:
    91            - name: githubOrg
    92          description: Name of the GitHub organization.
    93          resourceRef:
    94            - name: commonPipelineEnvironment
    95              param: github/owner
    96          scope:
    97            - GENERAL
    98            - PARAMETERS
    99            - STAGES
   100            - STEPS
   101          type: string
   102          mandatory: true
   103        - name: preRelease
   104          description: "If set to `true` the release will be marked as Pre-release."
   105          scope:
   106            - PARAMETERS
   107            - STAGES
   108            - STEPS
   109          type: bool
   110          default: false
   111        - name: releaseBodyHeader
   112          description: Content which will appear for the release.
   113          scope:
   114            - PARAMETERS
   115            - STAGES
   116            - STEPS
   117          type: string
   118        - name: repository
   119          aliases:
   120            - name: githubRepo
   121          description: Name of the GitHub repository.
   122          resourceRef:
   123            - name: commonPipelineEnvironment
   124              param: github/repository
   125          scope:
   126            - GENERAL
   127            - PARAMETERS
   128            - STAGES
   129            - STEPS
   130          type: string
   131          mandatory: true
   132        - name: serverUrl
   133          aliases:
   134            - name: githubServerUrl
   135          description: "GitHub server url for end-user access."
   136          scope:
   137            - GENERAL
   138            - PARAMETERS
   139            - STAGES
   140            - STEPS
   141          type: string
   142          default: https://github.com
   143          mandatory: true
   144        - name: tagPrefix
   145          type: string
   146          description: "Defines a prefix to be added to the tag."
   147          scope:
   148            - PARAMETERS
   149            - STAGES
   150            - STEPS
   151          default: ""
   152        - name: token
   153          aliases:
   154            - name: githubToken
   155            - name: access_token
   156          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"
   157          scope:
   158            - GENERAL
   159            - PARAMETERS
   160            - STAGES
   161            - STEPS
   162          type: string
   163          mandatory: true
   164          secret: true
   165          resourceRef:
   166            - name: githubTokenCredentialsId
   167              type: secret
   168            - type: vaultSecret
   169              default: github
   170              name: githubVaultSecretName
   171        - name: uploadUrl
   172          aliases:
   173            - name: githubUploadUrl
   174          description: Set the GitHub API url.
   175          scope:
   176            - GENERAL
   177            - PARAMETERS
   178            - STAGES
   179            - STEPS
   180          type: string
   181          default: https://uploads.github.com
   182          mandatory: true
   183        - name: version
   184          description: "Define the version number which will be written as tag as well as release name."
   185          resourceRef:
   186            - name: commonPipelineEnvironment
   187              param: artifactVersion
   188          scope:
   189            - PARAMETERS
   190            - STAGES
   191            - STEPS
   192          type: string
   193          mandatory: true