import * as pulumi from "@pulumi/pulumi"; /** * This resource allows you to create and manage a release in a specific * GitHub repository. * * ## Example Usage * * ```typescript * import * as pulumi from "@pulumi/pulumi"; * import * as github from "@pulumi/github"; * * const repo = new github.Repository("repo", { * name: "repo", * description: "GitHub repo managed by Terraform", * "private": false, * }); * const example = new github.Release("example", { * repository: repo.name, * tagName: "v1.0.0", * }); * ``` * * ### On Non-Default Branch * * ```typescript * import * as pulumi from "@pulumi/pulumi"; * import * as github from "@pulumi/github"; * * const example = new github.Repository("example", { * name: "repo", * autoInit: true, * }); * const exampleBranch = new github.Branch("example", { * repository: example.name, * branch: "branch_name", * sourceBranch: example.defaultBranch, * }); * const exampleRelease = new github.Release("example", { * repository: example.name, * tagName: "v1.0.0", * targetCommitish: exampleBranch.branch, * draft: false, * prerelease: false, * }); * ``` * * ## Import * * This resource can be imported using the `name` of the repository, combined with the `id` of the release, and a `:` character for separating components, e.g. * * ```sh * $ pulumi import github:index/release:Release example repo:12345678 * ``` */ export declare class Release extends pulumi.CustomResource { /** * Get an existing Release resource's state with the given name, ID, and optional extra * properties used to qualify the lookup. * * @param name The _unique_ name of the resulting resource. * @param id The _unique_ provider ID of the resource to lookup. * @param state Any extra arguments used during the lookup. * @param opts Optional settings to control the behavior of the CustomResource. */ static get(name: string, id: pulumi.Input, state?: ReleaseState, opts?: pulumi.CustomResourceOptions): Release; /** * Returns true if the given object is an instance of Release. This is designed to work even * when multiple copies of the Pulumi SDK have been loaded into the same process. */ static isInstance(obj: any): obj is Release; /** * URL that can be provided to API calls displaying the attached assets to this release. */ readonly assetsUrl: pulumi.Output; /** * Text describing the contents of the tag. */ readonly body: pulumi.Output; /** * This is the date of the commit used for the release, and not the date when the release was drafted or published. */ readonly createdAt: pulumi.Output; /** * If specified, a discussion of the specified category is created and linked to the release. The value must be a category that already exists in the repository. For more information, see [Managing categories for discussions in your repository](https://docs.github.com/discussions/managing-discussions-for-your-community/managing-categories-for-discussions-in-your-repository). */ readonly discussionCategoryName: pulumi.Output; /** * Set to `false` to create a published release. */ readonly draft: pulumi.Output; readonly etag: pulumi.Output; /** * Set to `true` to automatically generate the name and body for this release. If `name` is specified, the specified `name` will be used; otherwise, a name will be automatically generated. If `body` is specified, the `body` will be pre-pended to the automatically generated notes. */ readonly generateReleaseNotes: pulumi.Output; /** * URL of the release in GitHub. */ readonly htmlUrl: pulumi.Output; /** * The name of the release. */ readonly name: pulumi.Output; /** * GraphQL global node id for use with v4 API */ readonly nodeId: pulumi.Output; /** * Set to `false` to identify the release as a full release. */ readonly prerelease: pulumi.Output; /** * This is the date when the release was published. This will be empty if the release is a draft. */ readonly publishedAt: pulumi.Output; /** * The ID of the release. */ readonly releaseId: pulumi.Output; /** * The name of the repository. */ readonly repository: pulumi.Output; /** * The name of the tag. */ readonly tagName: pulumi.Output; /** * URL that can be provided to API calls to fetch the release TAR archive. */ readonly tarballUrl: pulumi.Output; /** * The branch name or commit SHA the tag is created from. Defaults to the default branch of the repository. */ readonly targetCommitish: pulumi.Output; /** * URL that can be provided to API calls to upload assets. */ readonly uploadUrl: pulumi.Output; /** * URL that can be provided to API calls that reference this release. */ readonly url: pulumi.Output; /** * URL that can be provided to API calls to fetch the release ZIP archive. */ readonly zipballUrl: pulumi.Output; /** * Create a Release resource with the given unique name, arguments, and options. * * @param name The _unique_ name of the resource. * @param args The arguments to use to populate this resource's properties. * @param opts A bag of options that control this resource's behavior. */ constructor(name: string, args: ReleaseArgs, opts?: pulumi.CustomResourceOptions); } /** * Input properties used for looking up and filtering Release resources. */ export interface ReleaseState { /** * URL that can be provided to API calls displaying the attached assets to this release. */ assetsUrl?: pulumi.Input; /** * Text describing the contents of the tag. */ body?: pulumi.Input; /** * This is the date of the commit used for the release, and not the date when the release was drafted or published. */ createdAt?: pulumi.Input; /** * If specified, a discussion of the specified category is created and linked to the release. The value must be a category that already exists in the repository. For more information, see [Managing categories for discussions in your repository](https://docs.github.com/discussions/managing-discussions-for-your-community/managing-categories-for-discussions-in-your-repository). */ discussionCategoryName?: pulumi.Input; /** * Set to `false` to create a published release. */ draft?: pulumi.Input; etag?: pulumi.Input; /** * Set to `true` to automatically generate the name and body for this release. If `name` is specified, the specified `name` will be used; otherwise, a name will be automatically generated. If `body` is specified, the `body` will be pre-pended to the automatically generated notes. */ generateReleaseNotes?: pulumi.Input; /** * URL of the release in GitHub. */ htmlUrl?: pulumi.Input; /** * The name of the release. */ name?: pulumi.Input; /** * GraphQL global node id for use with v4 API */ nodeId?: pulumi.Input; /** * Set to `false` to identify the release as a full release. */ prerelease?: pulumi.Input; /** * This is the date when the release was published. This will be empty if the release is a draft. */ publishedAt?: pulumi.Input; /** * The ID of the release. */ releaseId?: pulumi.Input; /** * The name of the repository. */ repository?: pulumi.Input; /** * The name of the tag. */ tagName?: pulumi.Input; /** * URL that can be provided to API calls to fetch the release TAR archive. */ tarballUrl?: pulumi.Input; /** * The branch name or commit SHA the tag is created from. Defaults to the default branch of the repository. */ targetCommitish?: pulumi.Input; /** * URL that can be provided to API calls to upload assets. */ uploadUrl?: pulumi.Input; /** * URL that can be provided to API calls that reference this release. */ url?: pulumi.Input; /** * URL that can be provided to API calls to fetch the release ZIP archive. */ zipballUrl?: pulumi.Input; } /** * The set of arguments for constructing a Release resource. */ export interface ReleaseArgs { /** * Text describing the contents of the tag. */ body?: pulumi.Input; /** * If specified, a discussion of the specified category is created and linked to the release. The value must be a category that already exists in the repository. For more information, see [Managing categories for discussions in your repository](https://docs.github.com/discussions/managing-discussions-for-your-community/managing-categories-for-discussions-in-your-repository). */ discussionCategoryName?: pulumi.Input; /** * Set to `false` to create a published release. */ draft?: pulumi.Input; /** * Set to `true` to automatically generate the name and body for this release. If `name` is specified, the specified `name` will be used; otherwise, a name will be automatically generated. If `body` is specified, the `body` will be pre-pended to the automatically generated notes. */ generateReleaseNotes?: pulumi.Input; /** * The name of the release. */ name?: pulumi.Input; /** * Set to `false` to identify the release as a full release. */ prerelease?: pulumi.Input; /** * The name of the repository. */ repository: pulumi.Input; /** * The name of the tag. */ tagName: pulumi.Input; /** * The branch name or commit SHA the tag is created from. Defaults to the default branch of the repository. */ targetCommitish?: pulumi.Input; }