GetRelease

Use this data source to retrieve information about a GitHub release in a specific repository.

Example Usage

using Pulumi;
using Github = Pulumi.Github;

class MyStack : Stack
{
    public MyStack()
    {
        var example = Output.Create(Github.GetRelease.InvokeAsync(new Github.GetReleaseArgs
        {
            Owner = "example-owner",
            Repository = "example-repository",
            RetrieveBy = "latest",
        }));
    }

}

Coming soon!

import pulumi
import pulumi_github as github

example = github.get_release(owner="example-owner",
    repository="example-repository",
    retrieve_by="latest")

import * as pulumi from "@pulumi/pulumi";
import * as github from "@pulumi/github";

const example = pulumi.output(github.getRelease({
    owner: "example-owner",
    repository: "example-repository",
    retrieveBy: "latest",
}, { async: true }));

Using GetRelease

function getRelease(args: GetReleaseArgs, opts?: InvokeOptions): Promise<GetReleaseResult>

function  get_release(owner=None, release_id=None, release_tag=None, repository=None, retrieve_by=None, opts=None)

func GetRelease(ctx *Context, args *GetReleaseArgs, opts ...InvokeOption) (*GetReleaseResult, error)

public static class GetRelease {
    public static Task<GetReleaseResult> InvokeAsync(GetReleaseArgs args, InvokeOptions? opts = null)
}

The following arguments are supported:

Owner string: Owner of the repository.
Repository string: Name of the repository to retrieve the release from.
RetrieveBy string: Describes how to fetch the release. Valid values are id, tag, latest.
ReleaseId int: ID of the release to retrieve. Must be specified when retrieve_by = id.
ReleaseTag string: Tag of the release to retrieve. Must be specified when retrieve_by = tag.

Owner string: Owner of the repository.
Repository string: Name of the repository to retrieve the release from.
RetrieveBy string: Describes how to fetch the release. Valid values are id, tag, latest.
ReleaseId int: ID of the release to retrieve. Must be specified when retrieve_by = id.
ReleaseTag string: Tag of the release to retrieve. Must be specified when retrieve_by = tag.

owner string: Owner of the repository.
repository string: Name of the repository to retrieve the release from.
retrieveBy string: Describes how to fetch the release. Valid values are id, tag, latest.
releaseId number: ID of the release to retrieve. Must be specified when retrieve_by = id.
releaseTag string: Tag of the release to retrieve. Must be specified when retrieve_by = tag.

owner str: Owner of the repository.
repository str: Name of the repository to retrieve the release from.
retrieve_by str: Describes how to fetch the release. Valid values are id, tag, latest.
release_id float: ID of the release to retrieve. Must be specified when retrieve_by = id.
release_tag str: Tag of the release to retrieve. Must be specified when retrieve_by = tag.

GetRelease Result

The following output properties are available:

AssertsUrl string: URL of any associated assets with the release
Body string: Contents of the description (body) of a release
CreatedAt string: Date of release creation
Draft bool: (Boolean) indicates whether the release is a draft
HtmlUrl string: URL directing to detailed information on the release
Id string: The provider-assigned unique ID for this managed resource.
Name string: Name of release
Owner string
Prerelease bool: (Boolean) indicates whether the release is a prerelease
PublishedAt string: Date of release publishing
Repository string
RetrieveBy string
TarballUrl string: Download URL of a specific release in tar.gz format
TargetCommitish string: Commitish value that determines where the Git release is created from
UploadUrl string: URL that can be used to upload Assets to the release
Url string: Base URL of the release
ZipballUrl string: Download URL of a specific release in zip format
ReleaseId int: ID of release
ReleaseTag string: Tag of release

AssertsUrl string: URL of any associated assets with the release
Body string: Contents of the description (body) of a release
CreatedAt string: Date of release creation
Draft bool: (Boolean) indicates whether the release is a draft
HtmlUrl string: URL directing to detailed information on the release
Id string: The provider-assigned unique ID for this managed resource.
Name string: Name of release
Owner string
Prerelease bool: (Boolean) indicates whether the release is a prerelease
PublishedAt string: Date of release publishing
Repository string
RetrieveBy string
TarballUrl string: Download URL of a specific release in tar.gz format
TargetCommitish string: Commitish value that determines where the Git release is created from
UploadUrl string: URL that can be used to upload Assets to the release
Url string: Base URL of the release
ZipballUrl string: Download URL of a specific release in zip format
ReleaseId int: ID of release
ReleaseTag string: Tag of release

assertsUrl string: URL of any associated assets with the release
body string: Contents of the description (body) of a release
createdAt string: Date of release creation
draft boolean: (Boolean) indicates whether the release is a draft
htmlUrl string: URL directing to detailed information on the release
id string: The provider-assigned unique ID for this managed resource.
name string: Name of release
owner string
prerelease boolean: (Boolean) indicates whether the release is a prerelease
publishedAt string: Date of release publishing
repository string
retrieveBy string
tarballUrl string: Download URL of a specific release in tar.gz format
targetCommitish string: Commitish value that determines where the Git release is created from
uploadUrl string: URL that can be used to upload Assets to the release
url string: Base URL of the release
zipballUrl string: Download URL of a specific release in zip format
releaseId number: ID of release
releaseTag string: Tag of release

asserts_url str: URL of any associated assets with the release
body str: Contents of the description (body) of a release
created_at str: Date of release creation
draft bool: (Boolean) indicates whether the release is a draft
html_url str: URL directing to detailed information on the release
id str: The provider-assigned unique ID for this managed resource.
name str: Name of release
owner str
prerelease bool: (Boolean) indicates whether the release is a prerelease
published_at str: Date of release publishing
repository str
retrieve_by str
tarball_url str: Download URL of a specific release in tar.gz format
target_commitish str: Commitish value that determines where the Git release is created from
upload_url str: URL that can be used to upload Assets to the release
url str: Base URL of the release
zipball_url str: Download URL of a specific release in zip format
release_id float: ID of release
release_tag str: Tag of release

Package Details

Repository: https://github.com/pulumi/pulumi-github
License: Apache-2.0
Notes: This Pulumi package is based on the github Terraform Provider.

The Pulumi Platform

Get Started

Migrate to Pulumi

Solutions for All Teams and Engineers

Any Code

Any Cloud

GetRelease

Example Usage

Using GetRelease

GetRelease Result

Package Details

On This Page