@pulumi/github 5.0.0 → 5.2.0-alpha.1673638210

package/getOrganizationTeamSyncGroups.d.ts

@@ -1,10 +1,25 @@
 import * as pulumi from "@pulumi/pulumi";
-import { output as outputs } from "./types";
+import * as outputs from "./types/output";
+/**
+ * Use this data source to retrieve the identity provider (IdP) groups for an organization.
+ *
+ * ## Example Usage
+ *
+ * ```typescript
+ * import * as pulumi from "@pulumi/pulumi";
+ * import * as github from "@pulumi/github";
+ *
+ * const test = github.getOrganizationTeamSyncGroups({});
+ * ```
+ */
 export declare function getOrganizationTeamSyncGroups(opts?: pulumi.InvokeOptions): Promise<GetOrganizationTeamSyncGroupsResult>;
 /**
  * A collection of values returned by getOrganizationTeamSyncGroups.
  */
 export interface GetOrganizationTeamSyncGroupsResult {
+    /**
+     * An Array of GitHub Identity Provider Groups.  Each `group` block consists of the fields documented below.
+     */
     readonly groups: outputs.GetOrganizationTeamSyncGroupsGroup[];
     /**
      * The provider-assigned unique ID for this managed resource.

package/getOrganizationTeamSyncGroups.js

@@ -5,11 +5,20 @@ Object.defineProperty(exports, "__esModule", { value: true });
 exports.getOrganizationTeamSyncGroups = void 0;
 const pulumi = require("@pulumi/pulumi");
 const utilities = require("./utilities");
+/**
+ * Use this data source to retrieve the identity provider (IdP) groups for an organization.
+ *
+ * ## Example Usage
+ *
+ * ```typescript
+ * import * as pulumi from "@pulumi/pulumi";
+ * import * as github from "@pulumi/github";
+ *
+ * const test = github.getOrganizationTeamSyncGroups({});
+ * ```
+ */
 function getOrganizationTeamSyncGroups(opts) {
-    if (!opts) {
-        opts = {};
-    }
-    opts = pulumi.mergeOptions(utilities.resourceOptsDefaults(), opts);
+    opts = pulumi.mergeOptions(utilities.resourceOptsDefaults(), opts || {});
     return pulumi.runtime.invoke("github:index/getOrganizationTeamSyncGroups:getOrganizationTeamSyncGroups", {}, opts);
 }
 exports.getOrganizationTeamSyncGroups = getOrganizationTeamSyncGroups;

package/getOrganizationTeamSyncGroups.js.map

@@ -1 +1 @@
-{"version":3,"file":"getOrganizationTeamSyncGroups.js","sourceRoot":"","sources":["../getOrganizationTeamSyncGroups.ts"],"names":[],"mappings":";AAAA,wFAAwF;AACxF,iFAAiF;;;AAEjF,yCAAyC;AAEzC,yCAAyC;AAEzC,SAAgB,6BAA6B,CAAC,IAA2B;IACrE,IAAI,CAAC,IAAI,EAAE;QACP,IAAI,GAAG,EAAE,CAAA;KACZ;IAED,IAAI,GAAG,MAAM,CAAC,YAAY,CAAC,SAAS,CAAC,oBAAoB,EAAE,EAAE,IAAI,CAAC,CAAC;IACnE,OAAO,MAAM,CAAC,OAAO,CAAC,MAAM,CAAC,0EAA0E,EAAE,EACxG,EAAE,IAAI,CAAC,CAAC;AACb,CAAC;AARD,sEAQC"}
+{"version":3,"file":"getOrganizationTeamSyncGroups.js","sourceRoot":"","sources":["../getOrganizationTeamSyncGroups.ts"],"names":[],"mappings":";AAAA,wFAAwF;AACxF,iFAAiF;;;AAEjF,yCAAyC;AAGzC,yCAAyC;AAEzC;;;;;;;;;;;GAWG;AACH,SAAgB,6BAA6B,CAAC,IAA2B;IAErE,IAAI,GAAG,MAAM,CAAC,YAAY,CAAC,SAAS,CAAC,oBAAoB,EAAE,EAAE,IAAI,IAAI,EAAE,CAAC,CAAC;IACzE,OAAO,MAAM,CAAC,OAAO,CAAC,MAAM,CAAC,0EAA0E,EAAE,EACxG,EAAE,IAAI,CAAC,CAAC;AACb,CAAC;AALD,sEAKC"}

package/getOrganizationTeams.d.ts

@@ -1,11 +1,47 @@
 import * as pulumi from "@pulumi/pulumi";
-import { output as outputs } from "./types";
+import * as outputs from "./types/output";
+/**
+ * Use this data source to retrieve information about all GitHub teams in an organization.
+ *
+ * ## Example Usage
+ *
+ * To retrieve *all* teams of the organization:
+ *
+ * ```typescript
+ * import * as pulumi from "@pulumi/pulumi";
+ * import * as github from "@pulumi/github";
+ *
+ * const all = github.getOrganizationTeams({});
+ * ```
+ *
+ * To retrieve only the team's at the root of the organization:
+ *
+ * ```typescript
+ * import * as pulumi from "@pulumi/pulumi";
+ * import * as github from "@pulumi/github";
+ *
+ * const rootTeams = github.getOrganizationTeams({
+ *     rootTeamsOnly: true,
+ * });
+ * ```
+ */
 export declare function getOrganizationTeams(args?: GetOrganizationTeamsArgs, opts?: pulumi.InvokeOptions): Promise<GetOrganizationTeamsResult>;
 /**
  * A collection of arguments for invoking getOrganizationTeams.
  */
 export interface GetOrganizationTeamsArgs {
+    /**
+     * (Optional) Set the number of results per graphql query. Reducing this number can alleviate timeout errors. Accepts a value between 0 - 100. Defaults to `100`.
+     */
+    resultsPerPage?: number;
+    /**
+     * (Optional) Only return teams that are at the organization's root, i.e. no nested teams. Defaults to `false`.
+     */
     rootTeamsOnly?: boolean;
+    /**
+     * (Optional) Exclude the members and repositories of the team from the returned result. Defaults to `false`.
+     */
+    summaryOnly?: boolean;
 }
 /**
  * A collection of values returned by getOrganizationTeams.
@@ -15,13 +51,63 @@ export interface GetOrganizationTeamsResult {
      * The provider-assigned unique ID for this managed resource.
      */
     readonly id: string;
+    /**
+     * (Optional) Set the number of results per graphql query. Reducing this number can alleviate timeout errors. Accepts a value between 0 - 100. Defaults to `100`.
+     */
+    readonly resultsPerPage?: number;
+    /**
+     * (Optional) Only return teams that are at the organization's root, i.e. no nested teams. Defaults to `false`.
+     */
     readonly rootTeamsOnly?: boolean;
+    /**
+     * (Optional) Exclude the members and repositories of the team from the returned result. Defaults to `false`.
+     */
+    readonly summaryOnly?: boolean;
+    /**
+     * (Required) An Array of GitHub Teams.  Each `team` block consists of the fields documented below.
+     */
     readonly teams: outputs.GetOrganizationTeamsTeam[];
 }
+/**
+ * Use this data source to retrieve information about all GitHub teams in an organization.
+ *
+ * ## Example Usage
+ *
+ * To retrieve *all* teams of the organization:
+ *
+ * ```typescript
+ * import * as pulumi from "@pulumi/pulumi";
+ * import * as github from "@pulumi/github";
+ *
+ * const all = github.getOrganizationTeams({});
+ * ```
+ *
+ * To retrieve only the team's at the root of the organization:
+ *
+ * ```typescript
+ * import * as pulumi from "@pulumi/pulumi";
+ * import * as github from "@pulumi/github";
+ *
+ * const rootTeams = github.getOrganizationTeams({
+ *     rootTeamsOnly: true,
+ * });
+ * ```
+ */
 export declare function getOrganizationTeamsOutput(args?: GetOrganizationTeamsOutputArgs, opts?: pulumi.InvokeOptions): pulumi.Output<GetOrganizationTeamsResult>;
 /**
  * A collection of arguments for invoking getOrganizationTeams.
  */
 export interface GetOrganizationTeamsOutputArgs {
+    /**
+     * (Optional) Set the number of results per graphql query. Reducing this number can alleviate timeout errors. Accepts a value between 0 - 100. Defaults to `100`.
+     */
+    resultsPerPage?: pulumi.Input<number>;
+    /**
+     * (Optional) Only return teams that are at the organization's root, i.e. no nested teams. Defaults to `false`.
+     */
     rootTeamsOnly?: pulumi.Input<boolean>;
+    /**
+     * (Optional) Exclude the members and repositories of the team from the returned result. Defaults to `false`.
+     */
+    summaryOnly?: pulumi.Input<boolean>;
 }

package/getOrganizationTeams.js

@@ -5,19 +5,68 @@ Object.defineProperty(exports, "__esModule", { value: true });
 exports.getOrganizationTeamsOutput = exports.getOrganizationTeams = void 0;
 const pulumi = require("@pulumi/pulumi");
 const utilities = require("./utilities");
+/**
+ * Use this data source to retrieve information about all GitHub teams in an organization.
+ *
+ * ## Example Usage
+ *
+ * To retrieve *all* teams of the organization:
+ *
+ * ```typescript
+ * import * as pulumi from "@pulumi/pulumi";
+ * import * as github from "@pulumi/github";
+ *
+ * const all = github.getOrganizationTeams({});
+ * ```
+ *
+ * To retrieve only the team's at the root of the organization:
+ *
+ * ```typescript
+ * import * as pulumi from "@pulumi/pulumi";
+ * import * as github from "@pulumi/github";
+ *
+ * const rootTeams = github.getOrganizationTeams({
+ *     rootTeamsOnly: true,
+ * });
+ * ```
+ */
 function getOrganizationTeams(args, opts) {
     args = args || {};
-    if (!opts) {
-        opts = {};
-    }
-    opts = pulumi.mergeOptions(utilities.resourceOptsDefaults(), opts);
+    opts = pulumi.mergeOptions(utilities.resourceOptsDefaults(), opts || {});
     return pulumi.runtime.invoke("github:index/getOrganizationTeams:getOrganizationTeams", {
+        "resultsPerPage": args.resultsPerPage,
         "rootTeamsOnly": args.rootTeamsOnly,
+        "summaryOnly": args.summaryOnly,
     }, opts);
 }
 exports.getOrganizationTeams = getOrganizationTeams;
+/**
+ * Use this data source to retrieve information about all GitHub teams in an organization.
+ *
+ * ## Example Usage
+ *
+ * To retrieve *all* teams of the organization:
+ *
+ * ```typescript
+ * import * as pulumi from "@pulumi/pulumi";
+ * import * as github from "@pulumi/github";
+ *
+ * const all = github.getOrganizationTeams({});
+ * ```
+ *
+ * To retrieve only the team's at the root of the organization:
+ *
+ * ```typescript
+ * import * as pulumi from "@pulumi/pulumi";
+ * import * as github from "@pulumi/github";
+ *
+ * const rootTeams = github.getOrganizationTeams({
+ *     rootTeamsOnly: true,
+ * });
+ * ```
+ */
 function getOrganizationTeamsOutput(args, opts) {
-    return pulumi.output(args).apply(a => getOrganizationTeams(a, opts));
+    return pulumi.output(args).apply((a) => getOrganizationTeams(a, opts));
 }
 exports.getOrganizationTeamsOutput = getOrganizationTeamsOutput;
 //# sourceMappingURL=getOrganizationTeams.js.map

package/getOrganizationTeams.js.map

@@ -1 +1 @@
-{"version":3,"file":"getOrganizationTeams.js","sourceRoot":"","sources":["../getOrganizationTeams.ts"],"names":[],"mappings":";AAAA,wFAAwF;AACxF,iFAAiF;;;AAEjF,yCAAyC;AAEzC,yCAAyC;AAEzC,SAAgB,oBAAoB,CAAC,IAA+B,EAAE,IAA2B;IAC7F,IAAI,GAAG,IAAI,IAAI,EAAE,CAAC;IAClB,IAAI,CAAC,IAAI,EAAE;QACP,IAAI,GAAG,EAAE,CAAA;KACZ;IAED,IAAI,GAAG,MAAM,CAAC,YAAY,CAAC,SAAS,CAAC,oBAAoB,EAAE,EAAE,IAAI,CAAC,CAAC;IACnE,OAAO,MAAM,CAAC,OAAO,CAAC,MAAM,CAAC,wDAAwD,EAAE;QACnF,eAAe,EAAE,IAAI,CAAC,aAAa;KACtC,EAAE,IAAI,CAAC,CAAC;AACb,CAAC;AAVD,oDAUC;AAqBD,SAAgB,0BAA0B,CAAC,IAAqC,EAAE,IAA2B;IACzG,OAAO,MAAM,CAAC,MAAM,CAAC,IAAI,CAAC,CAAC,KAAK,CAAC,CAAC,CAAC,EAAE,CAAC,oBAAoB,CAAC,CAAC,EAAE,IAAI,CAAC,CAAC,CAAA;AACxE,CAAC;AAFD,gEAEC"}
+{"version":3,"file":"getOrganizationTeams.js","sourceRoot":"","sources":["../getOrganizationTeams.ts"],"names":[],"mappings":";AAAA,wFAAwF;AACxF,iFAAiF;;;AAEjF,yCAAyC;AAGzC,yCAAyC;AAEzC;;;;;;;;;;;;;;;;;;;;;;;;GAwBG;AACH,SAAgB,oBAAoB,CAAC,IAA+B,EAAE,IAA2B;IAC7F,IAAI,GAAG,IAAI,IAAI,EAAE,CAAC;IAElB,IAAI,GAAG,MAAM,CAAC,YAAY,CAAC,SAAS,CAAC,oBAAoB,EAAE,EAAE,IAAI,IAAI,EAAE,CAAC,CAAC;IACzE,OAAO,MAAM,CAAC,OAAO,CAAC,MAAM,CAAC,wDAAwD,EAAE;QACnF,gBAAgB,EAAE,IAAI,CAAC,cAAc;QACrC,eAAe,EAAE,IAAI,CAAC,aAAa;QACnC,aAAa,EAAE,IAAI,CAAC,WAAW;KAClC,EAAE,IAAI,CAAC,CAAC;AACb,CAAC;AATD,oDASC;AA6CD;;;;;;;;;;;;;;;;;;;;;;;;GAwBG;AACH,SAAgB,0BAA0B,CAAC,IAAqC,EAAE,IAA2B;IACzG,OAAO,MAAM,CAAC,MAAM,CAAC,IAAI,CAAC,CAAC,KAAK,CAAC,CAAC,CAAM,EAAE,EAAE,CAAC,oBAAoB,CAAC,CAAC,EAAE,IAAI,CAAC,CAAC,CAAA;AAC/E,CAAC;AAFD,gEAEC"}

package/getOrganizationWebhooks.d.ts

@@ -0,0 +1,31 @@
+import * as pulumi from "@pulumi/pulumi";
+import * as outputs from "./types/output";
+/**
+ * Use this data source to retrieve all webhooks of the organization.
+ *
+ * ## Example Usage
+ *
+ * To retrieve *all* webhooks of the organization:
+ *
+ * ```typescript
+ * import * as pulumi from "@pulumi/pulumi";
+ * import * as github from "@pulumi/github";
+ *
+ * const all = github.getOrganizationWebhooks({});
+ * ```
+ */
+export declare function getOrganizationWebhooks(opts?: pulumi.InvokeOptions): Promise<GetOrganizationWebhooksResult>;
+/**
+ * A collection of values returned by getOrganizationWebhooks.
+ */
+export interface GetOrganizationWebhooksResult {
+    /**
+     * The provider-assigned unique ID for this managed resource.
+     */
+    readonly id: string;
+    /**
+     * An Array of GitHub Webhooks.  Each `webhook` block consists of the fields documented below.
+     * ___
+     */
+    readonly webhooks: outputs.GetOrganizationWebhooksWebhook[];
+}

package/getOrganizationWebhooks.js

@@ -0,0 +1,27 @@
+"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.getOrganizationWebhooks = void 0;
+const pulumi = require("@pulumi/pulumi");
+const utilities = require("./utilities");
+/**
+ * Use this data source to retrieve all webhooks of the organization.
+ *
+ * ## Example Usage
+ *
+ * To retrieve *all* webhooks of the organization:
+ *
+ * ```typescript
+ * import * as pulumi from "@pulumi/pulumi";
+ * import * as github from "@pulumi/github";
+ *
+ * const all = github.getOrganizationWebhooks({});
+ * ```
+ */
+function getOrganizationWebhooks(opts) {
+    opts = pulumi.mergeOptions(utilities.resourceOptsDefaults(), opts || {});
+    return pulumi.runtime.invoke("github:index/getOrganizationWebhooks:getOrganizationWebhooks", {}, opts);
+}
+exports.getOrganizationWebhooks = getOrganizationWebhooks;
+//# sourceMappingURL=getOrganizationWebhooks.js.map

package/getOrganizationWebhooks.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"getOrganizationWebhooks.js","sourceRoot":"","sources":["../getOrganizationWebhooks.ts"],"names":[],"mappings":";AAAA,wFAAwF;AACxF,iFAAiF;;;AAEjF,yCAAyC;AAGzC,yCAAyC;AAEzC;;;;;;;;;;;;;GAaG;AACH,SAAgB,uBAAuB,CAAC,IAA2B;IAE/D,IAAI,GAAG,MAAM,CAAC,YAAY,CAAC,SAAS,CAAC,oBAAoB,EAAE,EAAE,IAAI,IAAI,EAAE,CAAC,CAAC;IACzE,OAAO,MAAM,CAAC,OAAO,CAAC,MAAM,CAAC,8DAA8D,EAAE,EAC5F,EAAE,IAAI,CAAC,CAAC;AACb,CAAC;AALD,0DAKC"}

package/getRef.d.ts

@@ -1,16 +1,40 @@
 import * as pulumi from "@pulumi/pulumi";
+/**
+ * Use this data source to retrieve information about a repository ref.
+ *
+ * ## Example Usage
+ *
+ * ```typescript
+ * import * as pulumi from "@pulumi/pulumi";
+ * import * as github from "@pulumi/github";
+ *
+ * const development = github.getRef({
+ *     ref: "heads/development",
+ *     repository: "example",
+ * });
+ * ```
+ */
 export declare function getRef(args: GetRefArgs, opts?: pulumi.InvokeOptions): Promise<GetRefResult>;
 /**
  * A collection of arguments for invoking getRef.
  */
 export interface GetRefArgs {
+    /**
+     * The repository ref to look up. Must be formatted `heads/<ref>` for branches, and `tags/<ref>` for tags.
+     */
     ref: string;
+    /**
+     * The GitHub repository name.
+     */
     repository: string;
 }
 /**
  * A collection of values returned by getRef.
  */
 export interface GetRefResult {
+    /**
+     * An etag representing the ref.
+     */
     readonly etag: string;
     /**
      * The provider-assigned unique ID for this managed resource.
@@ -18,13 +42,37 @@ export interface GetRefResult {
     readonly id: string;
     readonly ref: string;
     readonly repository: string;
+    /**
+     * A string storing the reference's `HEAD` commit's SHA1.
+     */
     readonly sha: string;
 }
+/**
+ * Use this data source to retrieve information about a repository ref.
+ *
+ * ## Example Usage
+ *
+ * ```typescript
+ * import * as pulumi from "@pulumi/pulumi";
+ * import * as github from "@pulumi/github";
+ *
+ * const development = github.getRef({
+ *     ref: "heads/development",
+ *     repository: "example",
+ * });
+ * ```
+ */
 export declare function getRefOutput(args: GetRefOutputArgs, opts?: pulumi.InvokeOptions): pulumi.Output<GetRefResult>;
 /**
  * A collection of arguments for invoking getRef.
  */
 export interface GetRefOutputArgs {
+    /**
+     * The repository ref to look up. Must be formatted `heads/<ref>` for branches, and `tags/<ref>` for tags.
+     */
     ref: pulumi.Input<string>;
+    /**
+     * The GitHub repository name.
+     */
     repository: pulumi.Input<string>;
 }

package/getRef.js

@@ -5,19 +5,46 @@ Object.defineProperty(exports, "__esModule", { value: true });
 exports.getRefOutput = exports.getRef = void 0;
 const pulumi = require("@pulumi/pulumi");
 const utilities = require("./utilities");
+/**
+ * Use this data source to retrieve information about a repository ref.
+ *
+ * ## Example Usage
+ *
+ * ```typescript
+ * import * as pulumi from "@pulumi/pulumi";
+ * import * as github from "@pulumi/github";
+ *
+ * const development = github.getRef({
+ *     ref: "heads/development",
+ *     repository: "example",
+ * });
+ * ```
+ */
 function getRef(args, opts) {
-    if (!opts) {
-        opts = {};
-    }
-    opts = pulumi.mergeOptions(utilities.resourceOptsDefaults(), opts);
+    opts = pulumi.mergeOptions(utilities.resourceOptsDefaults(), opts || {});
     return pulumi.runtime.invoke("github:index/getRef:getRef", {
         "ref": args.ref,
         "repository": args.repository,
     }, opts);
 }
 exports.getRef = getRef;
+/**
+ * Use this data source to retrieve information about a repository ref.
+ *
+ * ## Example Usage
+ *
+ * ```typescript
+ * import * as pulumi from "@pulumi/pulumi";
+ * import * as github from "@pulumi/github";
+ *
+ * const development = github.getRef({
+ *     ref: "heads/development",
+ *     repository: "example",
+ * });
+ * ```
+ */
 function getRefOutput(args, opts) {
-    return pulumi.output(args).apply(a => getRef(a, opts));
+    return pulumi.output(args).apply((a) => getRef(a, opts));
 }
 exports.getRefOutput = getRefOutput;
 //# sourceMappingURL=getRef.js.map

package/getRef.js.map

@@ -1 +1 @@
-{"version":3,"file":"getRef.js","sourceRoot":"","sources":["../getRef.ts"],"names":[],"mappings":";AAAA,wFAAwF;AACxF,iFAAiF;;;AAEjF,yCAAyC;AACzC,yCAAyC;AAEzC,SAAgB,MAAM,CAAC,IAAgB,EAAE,IAA2B;IAChE,IAAI,CAAC,IAAI,EAAE;QACP,IAAI,GAAG,EAAE,CAAA;KACZ;IAED,IAAI,GAAG,MAAM,CAAC,YAAY,CAAC,SAAS,CAAC,oBAAoB,EAAE,EAAE,IAAI,CAAC,CAAC;IACnE,OAAO,MAAM,CAAC,OAAO,CAAC,MAAM,CAAC,4BAA4B,EAAE;QACvD,KAAK,EAAE,IAAI,CAAC,GAAG;QACf,YAAY,EAAE,IAAI,CAAC,UAAU;KAChC,EAAE,IAAI,CAAC,CAAC;AACb,CAAC;AAVD,wBAUC;AAwBD,SAAgB,YAAY,CAAC,IAAsB,EAAE,IAA2B;IAC5E,OAAO,MAAM,CAAC,MAAM,CAAC,IAAI,CAAC,CAAC,KAAK,CAAC,CAAC,CAAC,EAAE,CAAC,MAAM,CAAC,CAAC,EAAE,IAAI,CAAC,CAAC,CAAA;AAC1D,CAAC;AAFD,oCAEC"}
+{"version":3,"file":"getRef.js","sourceRoot":"","sources":["../getRef.ts"],"names":[],"mappings":";AAAA,wFAAwF;AACxF,iFAAiF;;;AAEjF,yCAAyC;AACzC,yCAAyC;AAEzC;;;;;;;;;;;;;;GAcG;AACH,SAAgB,MAAM,CAAC,IAAgB,EAAE,IAA2B;IAEhE,IAAI,GAAG,MAAM,CAAC,YAAY,CAAC,SAAS,CAAC,oBAAoB,EAAE,EAAE,IAAI,IAAI,EAAE,CAAC,CAAC;IACzE,OAAO,MAAM,CAAC,OAAO,CAAC,MAAM,CAAC,4BAA4B,EAAE;QACvD,KAAK,EAAE,IAAI,CAAC,GAAG;QACf,YAAY,EAAE,IAAI,CAAC,UAAU;KAChC,EAAE,IAAI,CAAC,CAAC;AACb,CAAC;AAPD,wBAOC;AAmCD;;;;;;;;;;;;;;GAcG;AACH,SAAgB,YAAY,CAAC,IAAsB,EAAE,IAA2B;IAC5E,OAAO,MAAM,CAAC,MAAM,CAAC,IAAI,CAAC,CAAC,KAAK,CAAC,CAAC,CAAM,EAAE,EAAE,CAAC,MAAM,CAAC,CAAC,EAAE,IAAI,CAAC,CAAC,CAAA;AACjE,CAAC;AAFD,oCAEC"}

package/getRelease.d.ts

@@ -1,50 +1,142 @@
 import * as pulumi from "@pulumi/pulumi";
+import * as outputs from "./types/output";
+/**
+ * Use this data source to retrieve information about a GitHub release in a specific repository.
+ */
 export declare function getRelease(args: GetReleaseArgs, opts?: pulumi.InvokeOptions): Promise<GetReleaseResult>;
 /**
  * A collection of arguments for invoking getRelease.
  */
 export interface GetReleaseArgs {
+    /**
+     * Owner of the repository.
+     */
     owner: string;
+    /**
+     * ID of the release to retrieve. Must be specified when `retrieveBy` = `id`.
+     */
     releaseId?: number;
+    /**
+     * Tag of the release to retrieve. Must be specified when `retrieveBy` = `tag`.
+     */
     releaseTag?: string;
+    /**
+     * Name of the repository to retrieve the release from.
+     */
     repository: string;
+    /**
+     * Describes how to fetch the release. Valid values are `id`, `tag`, `latest`.
+     */
     retrieveBy: string;
 }
 /**
  * A collection of values returned by getRelease.
  */
 export interface GetReleaseResult {
+    /**
+     * **Deprecated**: Use `assetsUrl` resource instead
+     *
+     * @deprecated use assets_url instead
+     */
     readonly assertsUrl: string;
+    /**
+     * Collection of assets for the release. Each asset conforms to the following schema:
+     */
+    readonly assets: outputs.GetReleaseAsset[];
+    /**
+     * URL of any associated assets with the release
+     */
+    readonly assetsUrl: string;
+    /**
+     * Contents of the description (body) of a release
+     */
     readonly body: string;
+    /**
+     * Date the asset was created
+     */
     readonly createdAt: string;
+    /**
+     * (`Boolean`) indicates whether the release is a draft
+     */
     readonly draft: boolean;
+    /**
+     * URL directing to detailed information on the release
+     */
     readonly htmlUrl: string;
     /**
      * The provider-assigned unique ID for this managed resource.
      */
     readonly id: string;
+    /**
+     * The file name of the asset
+     */
     readonly name: string;
     readonly owner: string;
+    /**
+     * (`Boolean`) indicates whether the release is a prerelease
+     */
     readonly prerelease: boolean;
+    /**
+     * Date of release publishing
+     */
     readonly publishedAt: string;
+    /**
+     * ID of release
+     */
     readonly releaseId?: number;
+    /**
+     * Tag of release
+     */
     readonly releaseTag?: string;
     readonly repository: string;
     readonly retrieveBy: string;
+    /**
+     * Download URL of a specific release in `tar.gz` format
+     */
     readonly tarballUrl: string;
+    /**
+     * Commitish value that determines where the Git release is created from
+     */
     readonly targetCommitish: string;
+    /**
+     * URL that can be used to upload Assets to the release
+     */
     readonly uploadUrl: string;
+    /**
+     * URL of the asset
+     */
     readonly url: string;
+    /**
+     * Download URL of a specific release in `zip` format
+     */
     readonly zipballUrl: string;
 }
+/**
+ * Use this data source to retrieve information about a GitHub release in a specific repository.
+ */
 export declare function getReleaseOutput(args: GetReleaseOutputArgs, opts?: pulumi.InvokeOptions): pulumi.Output<GetReleaseResult>;
 /**
  * A collection of arguments for invoking getRelease.
  */
 export interface GetReleaseOutputArgs {
+    /**
+     * Owner of the repository.
+     */
     owner: pulumi.Input<string>;
+    /**
+     * ID of the release to retrieve. Must be specified when `retrieveBy` = `id`.
+     */
     releaseId?: pulumi.Input<number>;
+    /**
+     * Tag of the release to retrieve. Must be specified when `retrieveBy` = `tag`.
+     */
     releaseTag?: pulumi.Input<string>;
+    /**
+     * Name of the repository to retrieve the release from.
+     */
     repository: pulumi.Input<string>;
+    /**
+     * Describes how to fetch the release. Valid values are `id`, `tag`, `latest`.
+     */
     retrieveBy: pulumi.Input<string>;
 }

package/getRelease.js

@@ -5,11 +5,11 @@ Object.defineProperty(exports, "__esModule", { value: true });
 exports.getReleaseOutput = exports.getRelease = void 0;
 const pulumi = require("@pulumi/pulumi");
 const utilities = require("./utilities");
+/**
+ * Use this data source to retrieve information about a GitHub release in a specific repository.
+ */
 function getRelease(args, opts) {
-    if (!opts) {
-        opts = {};
-    }
-    opts = pulumi.mergeOptions(utilities.resourceOptsDefaults(), opts);
+    opts = pulumi.mergeOptions(utilities.resourceOptsDefaults(), opts || {});
     return pulumi.runtime.invoke("github:index/getRelease:getRelease", {
         "owner": args.owner,
         "releaseId": args.releaseId,
@@ -19,8 +19,11 @@ function getRelease(args, opts) {
     }, opts);
 }
 exports.getRelease = getRelease;
+/**
+ * Use this data source to retrieve information about a GitHub release in a specific repository.
+ */
 function getReleaseOutput(args, opts) {
-    return pulumi.output(args).apply(a => getRelease(a, opts));
+    return pulumi.output(args).apply((a) => getRelease(a, opts));
 }
 exports.getReleaseOutput = getReleaseOutput;
 //# sourceMappingURL=getRelease.js.map

package/getRelease.js.map

@@ -1 +1 @@
-{"version":3,"file":"getRelease.js","sourceRoot":"","sources":["../getRelease.ts"],"names":[],"mappings":";AAAA,wFAAwF;AACxF,iFAAiF;;;AAEjF,yCAAyC;AACzC,yCAAyC;AAEzC,SAAgB,UAAU,CAAC,IAAoB,EAAE,IAA2B;IACxE,IAAI,CAAC,IAAI,EAAE;QACP,IAAI,GAAG,EAAE,CAAA;KACZ;IAED,IAAI,GAAG,MAAM,CAAC,YAAY,CAAC,SAAS,CAAC,oBAAoB,EAAE,EAAE,IAAI,CAAC,CAAC;IACnE,OAAO,MAAM,CAAC,OAAO,CAAC,MAAM,CAAC,oCAAoC,EAAE;QAC/D,OAAO,EAAE,IAAI,CAAC,KAAK;QACnB,WAAW,EAAE,IAAI,CAAC,SAAS;QAC3B,YAAY,EAAE,IAAI,CAAC,UAAU;QAC7B,YAAY,EAAE,IAAI,CAAC,UAAU;QAC7B,YAAY,EAAE,IAAI,CAAC,UAAU;KAChC,EAAE,IAAI,CAAC,CAAC;AACb,CAAC;AAbD,gCAaC;AAyCD,SAAgB,gBAAgB,CAAC,IAA0B,EAAE,IAA2B;IACpF,OAAO,MAAM,CAAC,MAAM,CAAC,IAAI,CAAC,CAAC,KAAK,CAAC,CAAC,CAAC,EAAE,CAAC,UAAU,CAAC,CAAC,EAAE,IAAI,CAAC,CAAC,CAAA;AAC9D,CAAC;AAFD,4CAEC"}
+{"version":3,"file":"getRelease.js","sourceRoot":"","sources":["../getRelease.ts"],"names":[],"mappings":";AAAA,wFAAwF;AACxF,iFAAiF;;;AAEjF,yCAAyC;AAGzC,yCAAyC;AAEzC;;GAEG;AACH,SAAgB,UAAU,CAAC,IAAoB,EAAE,IAA2B;IAExE,IAAI,GAAG,MAAM,CAAC,YAAY,CAAC,SAAS,CAAC,oBAAoB,EAAE,EAAE,IAAI,IAAI,EAAE,CAAC,CAAC;IACzE,OAAO,MAAM,CAAC,OAAO,CAAC,MAAM,CAAC,oCAAoC,EAAE;QAC/D,OAAO,EAAE,IAAI,CAAC,KAAK;QACnB,WAAW,EAAE,IAAI,CAAC,SAAS;QAC3B,YAAY,EAAE,IAAI,CAAC,UAAU;QAC7B,YAAY,EAAE,IAAI,CAAC,UAAU;QAC7B,YAAY,EAAE,IAAI,CAAC,UAAU;KAChC,EAAE,IAAI,CAAC,CAAC;AACb,CAAC;AAVD,gCAUC;AA8GD;;GAEG;AACH,SAAgB,gBAAgB,CAAC,IAA0B,EAAE,IAA2B;IACpF,OAAO,MAAM,CAAC,MAAM,CAAC,IAAI,CAAC,CAAC,KAAK,CAAC,CAAC,CAAM,EAAE,EAAE,CAAC,UAAU,CAAC,CAAC,EAAE,IAAI,CAAC,CAAC,CAAA;AACrE,CAAC;AAFD,4CAEC"}