@pulumi/github 5.1.0 → 5.2.0-alpha.1673638210

package/release.d.ts

@@ -0,0 +1,194 @@
+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", {
+ *     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 exampleRepository = new github.Repository("exampleRepository", {autoInit: true});
+ * const exampleBranch = new github.Branch("exampleBranch", {
+ *     repository: exampleRepository.name,
+ *     branch: "branch_name",
+ *     sourceBranch: exampleRepository.defaultBranch,
+ * });
+ * const exampleRelease = new github.Release("exampleRelease", {
+ *     repository: exampleRepository.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<pulumi.ID>, 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;
+    /**
+     * Text describing the contents of the tag.
+     */
+    readonly body: pulumi.Output<string | undefined>;
+    /**
+     * 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<string | undefined>;
+    /**
+     * Set to `false` to create a published release.
+     */
+    readonly draft: pulumi.Output<boolean | undefined>;
+    readonly etag: pulumi.Output<string>;
+    /**
+     * 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<boolean | undefined>;
+    /**
+     * The name of the release.
+     */
+    readonly name: pulumi.Output<string>;
+    /**
+     * Set to `false` to identify the release as a full release.
+     */
+    readonly prerelease: pulumi.Output<boolean | undefined>;
+    /**
+     * The name of the repository.
+     */
+    readonly repository: pulumi.Output<string>;
+    /**
+     * The name of the tag.
+     */
+    readonly tagName: pulumi.Output<string>;
+    /**
+     * The branch name or commit SHA the tag is created from. Defaults to the default branch of the repository.
+     */
+    readonly targetCommitish: pulumi.Output<string | undefined>;
+    /**
+     * 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 {
+    /**
+     * Text describing the contents of the tag.
+     */
+    body?: pulumi.Input<string>;
+    /**
+     * 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<string>;
+    /**
+     * Set to `false` to create a published release.
+     */
+    draft?: pulumi.Input<boolean>;
+    etag?: pulumi.Input<string>;
+    /**
+     * 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<boolean>;
+    /**
+     * The name of the release.
+     */
+    name?: pulumi.Input<string>;
+    /**
+     * Set to `false` to identify the release as a full release.
+     */
+    prerelease?: pulumi.Input<boolean>;
+    /**
+     * The name of the repository.
+     */
+    repository?: pulumi.Input<string>;
+    /**
+     * The name of the tag.
+     */
+    tagName?: pulumi.Input<string>;
+    /**
+     * The branch name or commit SHA the tag is created from. Defaults to the default branch of the repository.
+     */
+    targetCommitish?: pulumi.Input<string>;
+}
+/**
+ * The set of arguments for constructing a Release resource.
+ */
+export interface ReleaseArgs {
+    /**
+     * Text describing the contents of the tag.
+     */
+    body?: pulumi.Input<string>;
+    /**
+     * 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<string>;
+    /**
+     * Set to `false` to create a published release.
+     */
+    draft?: pulumi.Input<boolean>;
+    /**
+     * 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<boolean>;
+    /**
+     * The name of the release.
+     */
+    name?: pulumi.Input<string>;
+    /**
+     * Set to `false` to identify the release as a full release.
+     */
+    prerelease?: pulumi.Input<boolean>;
+    /**
+     * The name of the repository.
+     */
+    repository: pulumi.Input<string>;
+    /**
+     * The name of the tag.
+     */
+    tagName: pulumi.Input<string>;
+    /**
+     * The branch name or commit SHA the tag is created from. Defaults to the default branch of the repository.
+     */
+    targetCommitish?: pulumi.Input<string>;
+}

package/release.js

@@ -0,0 +1,121 @@
+"use strict";
+// *** WARNING: this file was generated by the Pulumi Terraform Bridge (tfgen) Tool. ***
+// *** Do not edit by hand unless you're certain you know what you are doing! ***
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.Release = void 0;
+const pulumi = require("@pulumi/pulumi");
+const utilities = require("./utilities");
+/**
+ * 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", {
+ *     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 exampleRepository = new github.Repository("exampleRepository", {autoInit: true});
+ * const exampleBranch = new github.Branch("exampleBranch", {
+ *     repository: exampleRepository.name,
+ *     branch: "branch_name",
+ *     sourceBranch: exampleRepository.defaultBranch,
+ * });
+ * const exampleRelease = new github.Release("exampleRelease", {
+ *     repository: exampleRepository.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
+ * ```
+ */
+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, id, state, opts) {
+        return new Release(name, state, Object.assign(Object.assign({}, opts), { id: id }));
+    }
+    /**
+     * 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) {
+        if (obj === undefined || obj === null) {
+            return false;
+        }
+        return obj['__pulumiType'] === Release.__pulumiType;
+    }
+    constructor(name, argsOrState, opts) {
+        let resourceInputs = {};
+        opts = opts || {};
+        if (opts.id) {
+            const state = argsOrState;
+            resourceInputs["body"] = state ? state.body : undefined;
+            resourceInputs["discussionCategoryName"] = state ? state.discussionCategoryName : undefined;
+            resourceInputs["draft"] = state ? state.draft : undefined;
+            resourceInputs["etag"] = state ? state.etag : undefined;
+            resourceInputs["generateReleaseNotes"] = state ? state.generateReleaseNotes : undefined;
+            resourceInputs["name"] = state ? state.name : undefined;
+            resourceInputs["prerelease"] = state ? state.prerelease : undefined;
+            resourceInputs["repository"] = state ? state.repository : undefined;
+            resourceInputs["tagName"] = state ? state.tagName : undefined;
+            resourceInputs["targetCommitish"] = state ? state.targetCommitish : undefined;
+        }
+        else {
+            const args = argsOrState;
+            if ((!args || args.repository === undefined) && !opts.urn) {
+                throw new Error("Missing required property 'repository'");
+            }
+            if ((!args || args.tagName === undefined) && !opts.urn) {
+                throw new Error("Missing required property 'tagName'");
+            }
+            resourceInputs["body"] = args ? args.body : undefined;
+            resourceInputs["discussionCategoryName"] = args ? args.discussionCategoryName : undefined;
+            resourceInputs["draft"] = args ? args.draft : undefined;
+            resourceInputs["generateReleaseNotes"] = args ? args.generateReleaseNotes : undefined;
+            resourceInputs["name"] = args ? args.name : undefined;
+            resourceInputs["prerelease"] = args ? args.prerelease : undefined;
+            resourceInputs["repository"] = args ? args.repository : undefined;
+            resourceInputs["tagName"] = args ? args.tagName : undefined;
+            resourceInputs["targetCommitish"] = args ? args.targetCommitish : undefined;
+            resourceInputs["etag"] = undefined /*out*/;
+        }
+        opts = pulumi.mergeOptions(utilities.resourceOptsDefaults(), opts);
+        super(Release.__pulumiType, name, resourceInputs, opts);
+    }
+}
+exports.Release = Release;
+/** @internal */
+Release.__pulumiType = 'github:index/release:Release';
+//# sourceMappingURL=release.js.map

package/release.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"release.js","sourceRoot":"","sources":["../release.ts"],"names":[],"mappings":";AAAA,wFAAwF;AACxF,iFAAiF;;;AAEjF,yCAAyC;AACzC,yCAAyC;AAEzC;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GA+CG;AACH,MAAa,OAAQ,SAAQ,MAAM,CAAC,cAAc;IAC9C;;;;;;;;OAQG;IACI,MAAM,CAAC,GAAG,CAAC,IAAY,EAAE,EAA2B,EAAE,KAAoB,EAAE,IAAmC;QAClH,OAAO,IAAI,OAAO,CAAC,IAAI,EAAO,KAAK,kCAAO,IAAI,KAAE,EAAE,EAAE,EAAE,IAAG,CAAC;IAC9D,CAAC;IAKD;;;OAGG;IACI,MAAM,CAAC,UAAU,CAAC,GAAQ;QAC7B,IAAI,GAAG,KAAK,SAAS,IAAI,GAAG,KAAK,IAAI,EAAE;YACnC,OAAO,KAAK,CAAC;SAChB;QACD,OAAO,GAAG,CAAC,cAAc,CAAC,KAAK,OAAO,CAAC,YAAY,CAAC;IACxD,CAAC;IAgDD,YAAY,IAAY,EAAE,WAAwC,EAAE,IAAmC;QACnG,IAAI,cAAc,GAAkB,EAAE,CAAC;QACvC,IAAI,GAAG,IAAI,IAAI,EAAE,CAAC;QAClB,IAAI,IAAI,CAAC,EAAE,EAAE;YACT,MAAM,KAAK,GAAG,WAAuC,CAAC;YACtD,cAAc,CAAC,MAAM,CAAC,GAAG,KAAK,CAAC,CAAC,CAAC,KAAK,CAAC,IAAI,CAAC,CAAC,CAAC,SAAS,CAAC;YACxD,cAAc,CAAC,wBAAwB,CAAC,GAAG,KAAK,CAAC,CAAC,CAAC,KAAK,CAAC,sBAAsB,CAAC,CAAC,CAAC,SAAS,CAAC;YAC5F,cAAc,CAAC,OAAO,CAAC,GAAG,KAAK,CAAC,CAAC,CAAC,KAAK,CAAC,KAAK,CAAC,CAAC,CAAC,SAAS,CAAC;YAC1D,cAAc,CAAC,MAAM,CAAC,GAAG,KAAK,CAAC,CAAC,CAAC,KAAK,CAAC,IAAI,CAAC,CAAC,CAAC,SAAS,CAAC;YACxD,cAAc,CAAC,sBAAsB,CAAC,GAAG,KAAK,CAAC,CAAC,CAAC,KAAK,CAAC,oBAAoB,CAAC,CAAC,CAAC,SAAS,CAAC;YACxF,cAAc,CAAC,MAAM,CAAC,GAAG,KAAK,CAAC,CAAC,CAAC,KAAK,CAAC,IAAI,CAAC,CAAC,CAAC,SAAS,CAAC;YACxD,cAAc,CAAC,YAAY,CAAC,GAAG,KAAK,CAAC,CAAC,CAAC,KAAK,CAAC,UAAU,CAAC,CAAC,CAAC,SAAS,CAAC;YACpE,cAAc,CAAC,YAAY,CAAC,GAAG,KAAK,CAAC,CAAC,CAAC,KAAK,CAAC,UAAU,CAAC,CAAC,CAAC,SAAS,CAAC;YACpE,cAAc,CAAC,SAAS,CAAC,GAAG,KAAK,CAAC,CAAC,CAAC,KAAK,CAAC,OAAO,CAAC,CAAC,CAAC,SAAS,CAAC;YAC9D,cAAc,CAAC,iBAAiB,CAAC,GAAG,KAAK,CAAC,CAAC,CAAC,KAAK,CAAC,eAAe,CAAC,CAAC,CAAC,SAAS,CAAC;SACjF;aAAM;YACH,MAAM,IAAI,GAAG,WAAsC,CAAC;YACpD,IAAI,CAAC,CAAC,IAAI,IAAI,IAAI,CAAC,UAAU,KAAK,SAAS,CAAC,IAAI,CAAC,IAAI,CAAC,GAAG,EAAE;gBACvD,MAAM,IAAI,KAAK,CAAC,wCAAwC,CAAC,CAAC;aAC7D;YACD,IAAI,CAAC,CAAC,IAAI,IAAI,IAAI,CAAC,OAAO,KAAK,SAAS,CAAC,IAAI,CAAC,IAAI,CAAC,GAAG,EAAE;gBACpD,MAAM,IAAI,KAAK,CAAC,qCAAqC,CAAC,CAAC;aAC1D;YACD,cAAc,CAAC,MAAM,CAAC,GAAG,IAAI,CAAC,CAAC,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC,CAAC,SAAS,CAAC;YACtD,cAAc,CAAC,wBAAwB,CAAC,GAAG,IAAI,CAAC,CAAC,CAAC,IAAI,CAAC,sBAAsB,CAAC,CAAC,CAAC,SAAS,CAAC;YAC1F,cAAc,CAAC,OAAO,CAAC,GAAG,IAAI,CAAC,CAAC,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC,CAAC,SAAS,CAAC;YACxD,cAAc,CAAC,sBAAsB,CAAC,GAAG,IAAI,CAAC,CAAC,CAAC,IAAI,CAAC,oBAAoB,CAAC,CAAC,CAAC,SAAS,CAAC;YACtF,cAAc,CAAC,MAAM,CAAC,GAAG,IAAI,CAAC,CAAC,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC,CAAC,SAAS,CAAC;YACtD,cAAc,CAAC,YAAY,CAAC,GAAG,IAAI,CAAC,CAAC,CAAC,IAAI,CAAC,UAAU,CAAC,CAAC,CAAC,SAAS,CAAC;YAClE,cAAc,CAAC,YAAY,CAAC,GAAG,IAAI,CAAC,CAAC,CAAC,IAAI,CAAC,UAAU,CAAC,CAAC,CAAC,SAAS,CAAC;YAClE,cAAc,CAAC,SAAS,CAAC,GAAG,IAAI,CAAC,CAAC,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC,CAAC,SAAS,CAAC;YAC5D,cAAc,CAAC,iBAAiB,CAAC,GAAG,IAAI,CAAC,CAAC,CAAC,IAAI,CAAC,eAAe,CAAC,CAAC,CAAC,SAAS,CAAC;YAC5E,cAAc,CAAC,MAAM,CAAC,GAAG,SAAS,CAAC,OAAO,CAAC;SAC9C;QACD,IAAI,GAAG,MAAM,CAAC,YAAY,CAAC,SAAS,CAAC,oBAAoB,EAAE,EAAE,IAAI,CAAC,CAAC;QACnE,KAAK,CAAC,OAAO,CAAC,YAAY,EAAE,IAAI,EAAE,cAAc,EAAE,IAAI,CAAC,CAAC;IAC5D,CAAC;;AA9GL,0BA+GC;AAjGG,gBAAgB;AACO,oBAAY,GAAG,8BAA8B,CAAC"}