Muokkaa

Jaa

GitHubRelease@1 - GitHub Release v1 task

  • Artikkeli

Use this task to create, edit, or delete a GitHub release.

Syntax

# GitHub Release v1
# Create, edit, or delete a GitHub release.
- task: GitHubRelease@1
  inputs:
    gitHubConnection: # string. Required. GitHub connection (OAuth or PAT). 
    repositoryName: '$(Build.Repository.Name)' # string. Required. Repository. Default: $(Build.Repository.Name).
    action: 'create' # 'create' | 'edit' | 'delete'. Required. Action. Default: create.
    #target: '$(Build.SourceVersion)' # string. Required when action = create || action = edit. Target. Default: $(Build.SourceVersion).
    tagSource: 'gitTag' # 'gitTag' | 'userSpecifiedTag'. Required when action = create. Tag source. Default: gitTag.
    #tagPattern: # string. Optional. Use when tagSource = gitTag. Tag Pattern. 
    #tag: # string. Required when action = edit || action = delete || tagSource = userSpecifiedTag. Tag. 
    #title: # string. Optional. Use when action = create || action = edit. Release title. 
    #releaseNotesSource: 'filePath' # 'filePath' | 'inline'. Optional. Use when action = create || action = edit. Release notes source. Default: filePath.
    #releaseNotesFilePath: # string. Optional. Use when releaseNotesSource = filePath. Release notes file path. 
    #releaseNotesInline: # string. Optional. Use when releaseNotesSource = inline. Release notes. 
    #assets: '$(Build.ArtifactStagingDirectory)/*' # string. Optional. Use when action = create || action = edit. Assets. Default: $(Build.ArtifactStagingDirectory)/*.
    #assetUploadMode: 'delete' # 'delete' | 'replace'. Optional. Use when action = edit. Asset upload mode. Default: delete.
    #isDraft: false # boolean. Optional. Use when action = create || action = edit. Draft release. Default: false.
    #isPreRelease: false # boolean. Optional. Use when action = create || action = edit. Pre-release. Default: false.
    #addChangeLog: true # boolean. Optional. Use when action = create || action = edit. Add changelog. Default: true.
  # Changelog configuration
    changeLogCompareToRelease: 'lastFullRelease' # 'lastFullRelease' | 'lastNonDraftRelease' | 'lastNonDraftReleaseByTag'. Required when addChangeLog = true. Compare to. Default: lastFullRelease.
    #changeLogCompareToReleaseTag: # string. Required when changeLogCompareToRelease = lastNonDraftReleaseByTag && addChangeLog = true. Release Tag. 
    changeLogType: 'commitBased' # 'commitBased' | 'issueBased'. Required when addChangeLog = true. Changelog type. Default: commitBased.
    #changeLogLabels: '[{ "label" : "bug", "displayName" : "Bugs", "state" : "closed" }]' # string. Optional. Use when changeLogType = issueBased && addChangeLog = true. Categories. Default: [{ "label" : "bug", "displayName" : "Bugs", "state" : "closed" }].

Inputs

gitHubConnection - GitHub connection (OAuth or PAT)
string. Required.

Specifies the name of the GitHub service connection to use to connect to the GitHub repository. The connection must be based on a GitHub user's OAuth or a GitHub personal access token. For more information about service connections, see Manage service connections.


repositoryName - Repository
string. Required. Default value: $(Build.Repository.Name).

Specifies the name of the GitHub repository where you will create, edit, or delete the GitHub release.


action - Action
string. Required. Allowed values: create, edit, delete. Default value: create.

Specifies the type of release operation to perform. This task can create, edit, or delete a GitHub release.


target - Target
string. Required when action = create || action = edit. Default value: $(Build.SourceVersion).

Specifies the commit SHA or branch name you want to use to create the GitHub release, for example 48b11d8d6e92a22e3e9563a3f643699c16fd6e27 or main. You can also use a variable, like $(myCommitSHA), in this field.


tagSource - Tag source
string. Required when action = create. Allowed values: gitTag (Git tag), userSpecifiedTag (User specified tag). Default value: gitTag.

Specifies the tag you want to use for release creation. The gitTag option automatically uses the tag that is associated with the Git commit. Use the userSpecifiedTag option to manually provide a tag.


tagPattern - Tag Pattern
string. Optional. Use when tagSource = gitTag.

Specifies the Git tag pattern by using regex, for example release-v1.*. A GitHub release will be created only for commits that have matching Git tag.


tag - Tag
string. Required when action = edit || action = delete || tagSource = userSpecifiedTag.

Specifies the tag you want to use when you create, edit, or delete a release. You can also use a variable, like $(myTagName), in this field.


title - Release title
string. Optional. Use when action = create || action = edit.

Specifies the title of the GitHub release. If left empty, the tag will be used as the release title.


releaseNotesSource - Release notes source
string. Optional. Use when action = create || action = edit. Allowed values: filePath (Release notes file), inline (Inline release notes). Default value: filePath.

Specifies the description of the GitHub release. Use the filePath (Release notes file) option to use file contents as release notes. Use the inline (Inline release notes) option to manually enter release notes


releaseNotesFilePath - Release notes file path
string. Optional. Use when releaseNotesSource = filePath.

Specifies the file that contains the release notes.


releaseNotesInline - Release notes
string. Optional. Use when releaseNotesSource = inline.

Specifies the release notes. Markdown is supported.


assets - Assets
string. Optional. Use when action = create || action = edit. Default value: $(Build.ArtifactStagingDirectory)/*.

Specifies the files you want to upload as assets of the release. You can use wildcard characters to specify multiple files. For example, use $(Build.ArtifactStagingDirectory)/*.zip or use $(System.DefaultWorkingDirectory)/*.zip for release pipelines.

You can also specify multiple patterns, one per line. By default, all files in the $(Build.ArtifactStagingDirectory) directory will be uploaded. For more information about the list of pre-defined variables that are available, see build variables and release variables.


assetUploadMode - Asset upload mode
string. Optional. Use when action = edit. Allowed values: delete (Delete exisiting assets), replace (Replace existing assets). Default value: delete.

Specifies the asset upload mode you want to use. Use the delete (Delete existing assets) option to first delete any existing assets in the release and then upload all assets. Use the replace (Replace existing assets) option to replace any assets that have the same name.


isDraft - Draft release
boolean. Optional. Use when action = create || action = edit. Default value: false.

Indicates whether the release should be saved as a draft (unpublished). If false, the release will be published.


isPreRelease - Pre-release
boolean. Optional. Use when action = create || action = edit. Default value: false.

Indicates whether the release should be marked as a pre-release.


addChangeLog - Add changelog
boolean. Optional. Use when action = create || action = edit. Default value: true.

Specifies if you want to include a changelog. If set to true, a list of changes (commits and issues) between the current release and the last published release will be generated and appended to the release notes.


changeLogCompareToRelease - Compare to
string. Required when addChangeLog = true. Allowed values: lastFullRelease (Last full release), lastNonDraftRelease (Last non-draft release), lastNonDraftReleaseByTag (Last non-draft release by tag). Default value: lastFullRelease.

Indicates which release to compare with to generate the changelog:

  • lastFullRelease (Last full release): Compares the current release with the most recent non-draft release that is not marked as pre-release.
  • lastNonDraftRelease (Last non-draft release): Compares the current release with the most recent non-draft release.
  • lastNonDraftReleaseByTag (Last non-draft release by tag): Compares the current release with the last non-draft release matching the specified tag. You can also specify a regex instead of an exact tag.

changeLogCompareToReleaseTag - Release Tag
string. Required when changeLogCompareToRelease = lastNonDraftReleaseByTag && addChangeLog = true.

Specifies the regex for release tag. Release matching this tag will be used as base for changelog computation.


changeLogType - Changelog type
string. Required when addChangeLog = true. Allowed values: commitBased (Commit based), issueBased (Issue based). Default value: commitBased.

Specifies the changelog type. A changelog can be commit-based or issue-based. A commit-based changelog lists all commits included in a release. An issue-based changelog lists all the issues or pull requests (PRs) included in the release.


changeLogLabels - Categories
string. Optional. Use when changeLogType = issueBased && addChangeLog = true. Default value: [{ "label" : "bug", "displayName" : "Bugs", "state" : "closed" }].

Categorizes changes based on the label associated with the issue or PR. For a label, you can mention the display name for the category and the state of issue. Examples of labels include: "[{ "label" : "bug", "displayName" : "Bugs", "state" : "closed" }]". In cases where a change has multiple labels on it, the first specified label takes priority. Leave this field empty to see a flat list of issues or PRs.


Task control options

All tasks have control options in addition to their task inputs. For more information, see Control options and common task properties.

Output variables

None.

Remarks

Use this task in your pipeline to create, edit, or discard a GitHub release.

GitHub service connection

This task requires a GitHub service connection with Write permission to the GitHub repository. You can create a GitHub service connection in your Azure Pipelines project. Once created, use the name of the service connection in this task's settings.

Examples

Create a GitHub release

The following YAML creates a GitHub release every time the task runs. The build number is used as the tag version for the release. All .exe files and README.txt files in the $(Build.ArtifactStagingDirectory) folder are uploaded as assets. By default, the task also generates a change log (a list of commits and issues that are part of this release) and publishes it as release notes.

- task: GithubRelease@1 
  displayName: 'Create GitHub Release'      
  inputs:
    gitHubConnection: zenithworks
    repositoryName: zenithworks/javaAppWithMaven
    tagSource: manual
    tag: $(Build.BuildNumber)      
    assets: |
      $(Build.ArtifactStagingDirectory)/*.exe
      $(Build.ArtifactStagingDirectory)/README.txt

You can also control the creation of the release based on repository tags. The following YAML creates a GitHub release only when the commit that triggers the pipeline has a Git tag associated with it. The GitHub release is created with the same tag version as the associated Git tag.

- task: GithubRelease@1 
  displayName: 'Create GitHub Release'      
  inputs:
    gitHubConnection: zenithworks
    repositoryName: zenithworks/javaAppWithMaven           
    assets: $(Build.ArtifactStagingDirectory)/*.exe

You may also want to use the task in conjunction with task conditions to get even finer control over when the task runs, thereby restricting the creation of releases. For example, in the following YAML the task runs only when the pipeline is triggered by a Git tag matching the pattern 'refs/tags/release-v*'.

- task: GithubRelease@1 
  displayName: 'Create GitHub Release'   
  condition: startsWith(variables['Build.SourceBranch'], 'refs/tags/release-v')   
  inputs:
    gitHubConnection: zenithworks
    repositoryName: zenithworks/javaAppWithMaven           
    assets: $(Build.ArtifactStagingDirectory)/*.exe

Edit a GitHub release

The following YAML updates the status of a GitHub release from 'draft' to 'published'. The release to be edited is determined by the specified tag.

- task: GithubRelease@1
  displayName: 'Edit GitHub Release'
  inputs:
    gitHubConnection: zenithworks
    repositoryName: zenithworks/javaAppWithMaven
    action: edit
    tag: $(myDraftReleaseVersion)
    isDraft: false

Delete a GitHub release

The following YAML deletes a GitHub release. The release to be deleted is determined by the specified tag.

- task: GithubRelease@1
  displayName: 'Delete GitHub Release'
  inputs:
    gitHubConnection: zenithworks
    repositoryName: zenithworks/javaAppWithMaven
    action: delete
    tag: $(myDraftReleaseVersion)

Inline release notes

The following YAML create a GitHub release and add inline release notes.

- task: GitHubRelease@1
  inputs:
    gitHubConnection: <GITHUB_SERVICE_CONNECTION>
    repositoryName: '$(Build.Repository.Name)'
    action: 'create'
    target: '$(Build.SourceVersion)'
    tagSource: 'userSpecifiedTag'
    tag: <YOUR_TAG>
    title: <YOUR_TITLE>
    releaseNotesSource: 'inline'
    releaseNotesInline: <YOUR_RELEASE_NOTES>

Requirements

Requirement Description
Pipeline types YAML, Classic build, Classic release
Runs on Agent, DeploymentGroup
Demands None
Capabilities This task does not satisfy any demands for subsequent tasks in the job.
Command restrictions Any
Settable variables Any
Agent version 2.0.0 or greater
Task category Utility