DownloadGitHubRelease@0 - Download GitHub Release v0 task

Use this task to download a GitHub release from a repository.

Syntax

# Download GitHub Release v0
# Downloads a GitHub Release from a repository.
- task: DownloadGitHubRelease@0
  inputs:
    connection: # string. Required. GitHub Connection. 
    userRepository: # string. Required. Repository. 
    defaultVersionType: 'latest' # 'latest' | 'specificVersion' | 'specificTag'. Required. Default version. Default: latest.
    version: # string. Required when defaultVersionType != latest. Release. 
    #itemPattern: '**' # string. Item Pattern. Default: **.
    downloadPath: '$(System.ArtifactsDirectory)' # string. Required. Destination directory. Default: $(System.ArtifactsDirectory).

Inputs

connection - GitHub Connection
string. Required.

Specifies the GitHub service connection name. Learn more about service connections.

userRepository - Repository
string. Required.

Specifies the name of the GitHub repository that GitHub releases are downloaded from.

defaultVersionType - Default version
string. Required. Allowed values: latest (Latest Release), specificVersion (Specific Version), specificTag (Specific Tag). Default value: latest.

Downloads assets from the latest GitHub release or a specific GitHub release version/tag.

version - Release
string. Required when defaultVersionType != latest.

Defines the GitHub release version/tag to download. This option appears if specificVersion or specificTag is selected as the value for defaultVersionType.

itemPattern - Item Pattern
string. Default value: **.

The minimatch pattern that filters files to be downloaded. To download all files within a release, use the default value **.

downloadPath - Destination directory
string. Required. Default value: $(System.ArtifactsDirectory).

The path on the agent machine where the release assets are downloaded.

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 download assets from your GitHub release as part of your CI/CD pipeline.

GitHub service connection

This task requires a GitHub service connection with Read 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.

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.144.0 or greater
Task category	Utility