@pulumi/github 5.22.0-alpha.1698198281 → 5.22.0-alpha.1698202303

package/getEnterprise.js

@@ -7,6 +7,17 @@ const pulumi = require("@pulumi/pulumi");
 const utilities = require("./utilities");
 /**
  * Use this data source to retrieve basic information about a GitHub enterprise.
+ *
+ * ## Example Usage
+ *
+ * ```typescript
+ * import * as pulumi from "@pulumi/pulumi";
+ * import * as github from "@pulumi/github";
+ *
+ * const example = github.getEnterprise({
+ *     slug: "example-co",
+ * });
+ * ```
  */
 function getEnterprise(args, opts) {
     opts = pulumi.mergeOptions(utilities.resourceOptsDefaults(), opts || {});
@@ -17,6 +28,17 @@ function getEnterprise(args, opts) {
 exports.getEnterprise = getEnterprise;
 /**
  * Use this data source to retrieve basic information about a GitHub enterprise.
+ *
+ * ## Example Usage
+ *
+ * ```typescript
+ * import * as pulumi from "@pulumi/pulumi";
+ * import * as github from "@pulumi/github";
+ *
+ * const example = github.getEnterprise({
+ *     slug: "example-co",
+ * });
+ * ```
  */
 function getEnterpriseOutput(args, opts) {
     return pulumi.output(args).apply((a) => getEnterprise(a, opts));

package/getEnterprise.js.map

@@ -1 +1 @@
-{"version":3,"file":"getEnterprise.js","sourceRoot":"","sources":["../getEnterprise.ts"],"names":[],"mappings":";AAAA,wFAAwF;AACxF,iFAAiF;;;AAEjF,yCAAyC;AACzC,yCAAyC;AAEzC;;GAEG;AACH,SAAgB,aAAa,CAAC,IAAuB,EAAE,IAA2B;IAE9E,IAAI,GAAG,MAAM,CAAC,YAAY,CAAC,SAAS,CAAC,oBAAoB,EAAE,EAAE,IAAI,IAAI,EAAE,CAAC,CAAC;IACzE,OAAO,MAAM,CAAC,OAAO,CAAC,MAAM,CAAC,0CAA0C,EAAE;QACrE,MAAM,EAAE,IAAI,CAAC,IAAI;KACpB,EAAE,IAAI,CAAC,CAAC;AACb,CAAC;AAND,sCAMC;AAyCD;;GAEG;AACH,SAAgB,mBAAmB,CAAC,IAA6B,EAAE,IAA2B;IAC1F,OAAO,MAAM,CAAC,MAAM,CAAC,IAAI,CAAC,CAAC,KAAK,CAAC,CAAC,CAAM,EAAE,EAAE,CAAC,aAAa,CAAC,CAAC,EAAE,IAAI,CAAC,CAAC,CAAA;AACxE,CAAC;AAFD,kDAEC"}
+{"version":3,"file":"getEnterprise.js","sourceRoot":"","sources":["../getEnterprise.ts"],"names":[],"mappings":";AAAA,wFAAwF;AACxF,iFAAiF;;;AAEjF,yCAAyC;AACzC,yCAAyC;AAEzC;;;;;;;;;;;;;GAaG;AACH,SAAgB,aAAa,CAAC,IAAuB,EAAE,IAA2B;IAE9E,IAAI,GAAG,MAAM,CAAC,YAAY,CAAC,SAAS,CAAC,oBAAoB,EAAE,EAAE,IAAI,IAAI,EAAE,CAAC,CAAC;IACzE,OAAO,MAAM,CAAC,OAAO,CAAC,MAAM,CAAC,0CAA0C,EAAE;QACrE,MAAM,EAAE,IAAI,CAAC,IAAI;KACpB,EAAE,IAAI,CAAC,CAAC;AACb,CAAC;AAND,sCAMC;AAyCD;;;;;;;;;;;;;GAaG;AACH,SAAgB,mBAAmB,CAAC,IAA6B,EAAE,IAA2B;IAC1F,OAAO,MAAM,CAAC,MAAM,CAAC,IAAI,CAAC,CAAC,KAAK,CAAC,CAAC,CAAM,EAAE,EAAE,CAAC,aAAa,CAAC,CAAC,EAAE,IAAI,CAAC,CAAC,CAAA;AACxE,CAAC;AAFD,kDAEC"}

package/getExternalGroups.d.ts

@@ -2,6 +2,17 @@ import * as pulumi from "@pulumi/pulumi";
 import * as outputs from "./types/output";
 /**
  * Use this data source to retrieve external groups belonging to an organization.
+ *
+ * ## Example Usage
+ *
+ * ```typescript
+ * import * as pulumi from "@pulumi/pulumi";
+ * import * as github from "@pulumi/github";
+ *
+ * const exampleExternalGroups = github.getExternalGroups({});
+ * const localGroups = exampleExternalGroups;
+ * export const groups = localGroups;
+ * ```
  */
 export declare function getExternalGroups(opts?: pulumi.InvokeOptions): Promise<GetExternalGroupsResult>;
 /**
@@ -19,5 +30,16 @@ export interface GetExternalGroupsResult {
 }
 /**
  * Use this data source to retrieve external groups belonging to an organization.
+ *
+ * ## Example Usage
+ *
+ * ```typescript
+ * import * as pulumi from "@pulumi/pulumi";
+ * import * as github from "@pulumi/github";
+ *
+ * const exampleExternalGroups = github.getExternalGroups({});
+ * const localGroups = exampleExternalGroups;
+ * export const groups = localGroups;
+ * ```
  */
 export declare function getExternalGroupsOutput(opts?: pulumi.InvokeOptions): pulumi.Output<GetExternalGroupsResult>;

package/getExternalGroups.js

@@ -7,6 +7,17 @@ const pulumi = require("@pulumi/pulumi");
 const utilities = require("./utilities");
 /**
  * Use this data source to retrieve external groups belonging to an organization.
+ *
+ * ## Example Usage
+ *
+ * ```typescript
+ * import * as pulumi from "@pulumi/pulumi";
+ * import * as github from "@pulumi/github";
+ *
+ * const exampleExternalGroups = github.getExternalGroups({});
+ * const localGroups = exampleExternalGroups;
+ * export const groups = localGroups;
+ * ```
  */
 function getExternalGroups(opts) {
     opts = pulumi.mergeOptions(utilities.resourceOptsDefaults(), opts || {});
@@ -15,6 +26,17 @@ function getExternalGroups(opts) {
 exports.getExternalGroups = getExternalGroups;
 /**
  * Use this data source to retrieve external groups belonging to an organization.
+ *
+ * ## Example Usage
+ *
+ * ```typescript
+ * import * as pulumi from "@pulumi/pulumi";
+ * import * as github from "@pulumi/github";
+ *
+ * const exampleExternalGroups = github.getExternalGroups({});
+ * const localGroups = exampleExternalGroups;
+ * export const groups = localGroups;
+ * ```
  */
 function getExternalGroupsOutput(opts) {
     return pulumi.output(getExternalGroups(opts));

package/getExternalGroups.js.map

@@ -1 +1 @@
-{"version":3,"file":"getExternalGroups.js","sourceRoot":"","sources":["../getExternalGroups.ts"],"names":[],"mappings":";AAAA,wFAAwF;AACxF,iFAAiF;;;AAEjF,yCAAyC;AAGzC,yCAAyC;AAEzC;;GAEG;AACH,SAAgB,iBAAiB,CAAC,IAA2B;IAEzD,IAAI,GAAG,MAAM,CAAC,YAAY,CAAC,SAAS,CAAC,oBAAoB,EAAE,EAAE,IAAI,IAAI,EAAE,CAAC,CAAC;IACzE,OAAO,MAAM,CAAC,OAAO,CAAC,MAAM,CAAC,kDAAkD,EAAE,EAChF,EAAE,IAAI,CAAC,CAAC;AACb,CAAC;AALD,8CAKC;AAeD;;GAEG;AACH,SAAgB,uBAAuB,CAAC,IAA2B;IAC/D,OAAO,MAAM,CAAC,MAAM,CAAC,iBAAiB,CAAC,IAAI,CAAC,CAAC,CAAA;AACjD,CAAC;AAFD,0DAEC"}
+{"version":3,"file":"getExternalGroups.js","sourceRoot":"","sources":["../getExternalGroups.ts"],"names":[],"mappings":";AAAA,wFAAwF;AACxF,iFAAiF;;;AAEjF,yCAAyC;AAGzC,yCAAyC;AAEzC;;;;;;;;;;;;;GAaG;AACH,SAAgB,iBAAiB,CAAC,IAA2B;IAEzD,IAAI,GAAG,MAAM,CAAC,YAAY,CAAC,SAAS,CAAC,oBAAoB,EAAE,EAAE,IAAI,IAAI,EAAE,CAAC,CAAC;IACzE,OAAO,MAAM,CAAC,OAAO,CAAC,MAAM,CAAC,kDAAkD,EAAE,EAChF,EAAE,IAAI,CAAC,CAAC;AACb,CAAC;AALD,8CAKC;AAeD;;;;;;;;;;;;;GAaG;AACH,SAAgB,uBAAuB,CAAC,IAA2B;IAC/D,OAAO,MAAM,CAAC,MAAM,CAAC,iBAAiB,CAAC,IAAI,CAAC,CAAC,CAAA;AACjD,CAAC;AAFD,0DAEC"}

package/getGithubApp.d.ts

@@ -1,6 +1,17 @@
 import * as pulumi from "@pulumi/pulumi";
 /**
  * Use this data source to retrieve information about an app.
+ *
+ * ## Example Usage
+ *
+ * ```typescript
+ * import * as pulumi from "@pulumi/pulumi";
+ * import * as github from "@pulumi/github";
+ *
+ * const foobar = github.getGithubApp({
+ *     slug: "foobar",
+ * });
+ * ```
  */
 export declare function getGithubApp(args: GetGithubAppArgs, opts?: pulumi.InvokeOptions): Promise<GetGithubAppResult>;
 /**
@@ -36,6 +47,17 @@ export interface GetGithubAppResult {
 }
 /**
  * Use this data source to retrieve information about an app.
+ *
+ * ## Example Usage
+ *
+ * ```typescript
+ * import * as pulumi from "@pulumi/pulumi";
+ * import * as github from "@pulumi/github";
+ *
+ * const foobar = github.getGithubApp({
+ *     slug: "foobar",
+ * });
+ * ```
  */
 export declare function getGithubAppOutput(args: GetGithubAppOutputArgs, opts?: pulumi.InvokeOptions): pulumi.Output<GetGithubAppResult>;
 /**

package/getGithubApp.js

@@ -7,6 +7,17 @@ const pulumi = require("@pulumi/pulumi");
 const utilities = require("./utilities");
 /**
  * Use this data source to retrieve information about an app.
+ *
+ * ## Example Usage
+ *
+ * ```typescript
+ * import * as pulumi from "@pulumi/pulumi";
+ * import * as github from "@pulumi/github";
+ *
+ * const foobar = github.getGithubApp({
+ *     slug: "foobar",
+ * });
+ * ```
  */
 function getGithubApp(args, opts) {
     opts = pulumi.mergeOptions(utilities.resourceOptsDefaults(), opts || {});
@@ -17,6 +28,17 @@ function getGithubApp(args, opts) {
 exports.getGithubApp = getGithubApp;
 /**
  * Use this data source to retrieve information about an app.
+ *
+ * ## Example Usage
+ *
+ * ```typescript
+ * import * as pulumi from "@pulumi/pulumi";
+ * import * as github from "@pulumi/github";
+ *
+ * const foobar = github.getGithubApp({
+ *     slug: "foobar",
+ * });
+ * ```
  */
 function getGithubAppOutput(args, opts) {
     return pulumi.output(args).apply((a) => getGithubApp(a, opts));

package/getGithubApp.js.map

@@ -1 +1 @@
-{"version":3,"file":"getGithubApp.js","sourceRoot":"","sources":["../getGithubApp.ts"],"names":[],"mappings":";AAAA,wFAAwF;AACxF,iFAAiF;;;AAEjF,yCAAyC;AACzC,yCAAyC;AAEzC;;GAEG;AACH,SAAgB,YAAY,CAAC,IAAsB,EAAE,IAA2B;IAE5E,IAAI,GAAG,MAAM,CAAC,YAAY,CAAC,SAAS,CAAC,oBAAoB,EAAE,EAAE,IAAI,IAAI,EAAE,CAAC,CAAC;IACzE,OAAO,MAAM,CAAC,OAAO,CAAC,MAAM,CAAC,wCAAwC,EAAE;QACnE,MAAM,EAAE,IAAI,CAAC,IAAI;KACpB,EAAE,IAAI,CAAC,CAAC;AACb,CAAC;AAND,oCAMC;AAkCD;;GAEG;AACH,SAAgB,kBAAkB,CAAC,IAA4B,EAAE,IAA2B;IACxF,OAAO,MAAM,CAAC,MAAM,CAAC,IAAI,CAAC,CAAC,KAAK,CAAC,CAAC,CAAM,EAAE,EAAE,CAAC,YAAY,CAAC,CAAC,EAAE,IAAI,CAAC,CAAC,CAAA;AACvE,CAAC;AAFD,gDAEC"}
+{"version":3,"file":"getGithubApp.js","sourceRoot":"","sources":["../getGithubApp.ts"],"names":[],"mappings":";AAAA,wFAAwF;AACxF,iFAAiF;;;AAEjF,yCAAyC;AACzC,yCAAyC;AAEzC;;;;;;;;;;;;;GAaG;AACH,SAAgB,YAAY,CAAC,IAAsB,EAAE,IAA2B;IAE5E,IAAI,GAAG,MAAM,CAAC,YAAY,CAAC,SAAS,CAAC,oBAAoB,EAAE,EAAE,IAAI,IAAI,EAAE,CAAC,CAAC;IACzE,OAAO,MAAM,CAAC,OAAO,CAAC,MAAM,CAAC,wCAAwC,EAAE;QACnE,MAAM,EAAE,IAAI,CAAC,IAAI;KACpB,EAAE,IAAI,CAAC,CAAC;AACb,CAAC;AAND,oCAMC;AAkCD;;;;;;;;;;;;;GAaG;AACH,SAAgB,kBAAkB,CAAC,IAA4B,EAAE,IAA2B;IACxF,OAAO,MAAM,CAAC,MAAM,CAAC,IAAI,CAAC,CAAC,KAAK,CAAC,CAAC,CAAM,EAAE,EAAE,CAAC,YAAY,CAAC,CAAC,EAAE,IAAI,CAAC,CAAC,CAAA;AACvE,CAAC;AAFD,gDAEC"}

package/getIpRanges.d.ts

@@ -1,6 +1,15 @@
 import * as pulumi from "@pulumi/pulumi";
 /**
  * Use this data source to retrieve information about GitHub's IP addresses.
+ *
+ * ## Example Usage
+ *
+ * ```typescript
+ * import * as pulumi from "@pulumi/pulumi";
+ * import * as github from "@pulumi/github";
+ *
+ * const test = github.getIpRanges({});
+ * ```
  */
 export declare function getIpRanges(opts?: pulumi.InvokeOptions): Promise<GetIpRangesResult>;
 /**
@@ -110,5 +119,14 @@ export interface GetIpRangesResult {
 }
 /**
  * Use this data source to retrieve information about GitHub's IP addresses.
+ *
+ * ## Example Usage
+ *
+ * ```typescript
+ * import * as pulumi from "@pulumi/pulumi";
+ * import * as github from "@pulumi/github";
+ *
+ * const test = github.getIpRanges({});
+ * ```
  */
 export declare function getIpRangesOutput(opts?: pulumi.InvokeOptions): pulumi.Output<GetIpRangesResult>;

package/getIpRanges.js

@@ -7,6 +7,15 @@ const pulumi = require("@pulumi/pulumi");
 const utilities = require("./utilities");
 /**
  * Use this data source to retrieve information about GitHub's IP addresses.
+ *
+ * ## Example Usage
+ *
+ * ```typescript
+ * import * as pulumi from "@pulumi/pulumi";
+ * import * as github from "@pulumi/github";
+ *
+ * const test = github.getIpRanges({});
+ * ```
  */
 function getIpRanges(opts) {
     opts = pulumi.mergeOptions(utilities.resourceOptsDefaults(), opts || {});
@@ -15,6 +24,15 @@ function getIpRanges(opts) {
 exports.getIpRanges = getIpRanges;
 /**
  * Use this data source to retrieve information about GitHub's IP addresses.
+ *
+ * ## Example Usage
+ *
+ * ```typescript
+ * import * as pulumi from "@pulumi/pulumi";
+ * import * as github from "@pulumi/github";
+ *
+ * const test = github.getIpRanges({});
+ * ```
  */
 function getIpRangesOutput(opts) {
     return pulumi.output(getIpRanges(opts));

package/getIpRanges.js.map

@@ -1 +1 @@
-{"version":3,"file":"getIpRanges.js","sourceRoot":"","sources":["../getIpRanges.ts"],"names":[],"mappings":";AAAA,wFAAwF;AACxF,iFAAiF;;;AAEjF,yCAAyC;AACzC,yCAAyC;AAEzC;;GAEG;AACH,SAAgB,WAAW,CAAC,IAA2B;IAEnD,IAAI,GAAG,MAAM,CAAC,YAAY,CAAC,SAAS,CAAC,oBAAoB,EAAE,EAAE,IAAI,IAAI,EAAE,CAAC,CAAC;IACzE,OAAO,MAAM,CAAC,OAAO,CAAC,MAAM,CAAC,sCAAsC,EAAE,EACpE,EAAE,IAAI,CAAC,CAAC;AACb,CAAC;AALD,kCAKC;AA2GD;;GAEG;AACH,SAAgB,iBAAiB,CAAC,IAA2B;IACzD,OAAO,MAAM,CAAC,MAAM,CAAC,WAAW,CAAC,IAAI,CAAC,CAAC,CAAA;AAC3C,CAAC;AAFD,8CAEC"}
+{"version":3,"file":"getIpRanges.js","sourceRoot":"","sources":["../getIpRanges.ts"],"names":[],"mappings":";AAAA,wFAAwF;AACxF,iFAAiF;;;AAEjF,yCAAyC;AACzC,yCAAyC;AAEzC;;;;;;;;;;;GAWG;AACH,SAAgB,WAAW,CAAC,IAA2B;IAEnD,IAAI,GAAG,MAAM,CAAC,YAAY,CAAC,SAAS,CAAC,oBAAoB,EAAE,EAAE,IAAI,IAAI,EAAE,CAAC,CAAC;IACzE,OAAO,MAAM,CAAC,OAAO,CAAC,MAAM,CAAC,sCAAsC,EAAE,EACpE,EAAE,IAAI,CAAC,CAAC;AACb,CAAC;AALD,kCAKC;AA2GD;;;;;;;;;;;GAWG;AACH,SAAgB,iBAAiB,CAAC,IAA2B;IACzD,OAAO,MAAM,CAAC,MAAM,CAAC,WAAW,CAAC,IAAI,CAAC,CAAC,CAAA;AAC3C,CAAC;AAFD,8CAEC"}

package/getMembership.d.ts

@@ -4,6 +4,17 @@ import * as pulumi from "@pulumi/pulumi";
  * as what role they have within it.
  * If the user's membership in the organization is pending their acceptance of an invite,
  * the role they would have once they accept will be returned.
+ *
+ * ## Example Usage
+ *
+ * ```typescript
+ * import * as pulumi from "@pulumi/pulumi";
+ * import * as github from "@pulumi/github";
+ *
+ * const membershipForSomeUser = github.getMembership({
+ *     username: "SomeUser",
+ * });
+ * ```
  */
 export declare function getMembership(args: GetMembershipArgs, opts?: pulumi.InvokeOptions): Promise<GetMembershipResult>;
 /**
@@ -50,6 +61,17 @@ export interface GetMembershipResult {
  * as what role they have within it.
  * If the user's membership in the organization is pending their acceptance of an invite,
  * the role they would have once they accept will be returned.
+ *
+ * ## Example Usage
+ *
+ * ```typescript
+ * import * as pulumi from "@pulumi/pulumi";
+ * import * as github from "@pulumi/github";
+ *
+ * const membershipForSomeUser = github.getMembership({
+ *     username: "SomeUser",
+ * });
+ * ```
  */
 export declare function getMembershipOutput(args: GetMembershipOutputArgs, opts?: pulumi.InvokeOptions): pulumi.Output<GetMembershipResult>;
 /**

package/getMembership.js

@@ -10,6 +10,17 @@ const utilities = require("./utilities");
  * as what role they have within it.
  * If the user's membership in the organization is pending their acceptance of an invite,
  * the role they would have once they accept will be returned.
+ *
+ * ## Example Usage
+ *
+ * ```typescript
+ * import * as pulumi from "@pulumi/pulumi";
+ * import * as github from "@pulumi/github";
+ *
+ * const membershipForSomeUser = github.getMembership({
+ *     username: "SomeUser",
+ * });
+ * ```
  */
 function getMembership(args, opts) {
     opts = pulumi.mergeOptions(utilities.resourceOptsDefaults(), opts || {});
@@ -24,6 +35,17 @@ exports.getMembership = getMembership;
  * as what role they have within it.
  * If the user's membership in the organization is pending their acceptance of an invite,
  * the role they would have once they accept will be returned.
+ *
+ * ## Example Usage
+ *
+ * ```typescript
+ * import * as pulumi from "@pulumi/pulumi";
+ * import * as github from "@pulumi/github";
+ *
+ * const membershipForSomeUser = github.getMembership({
+ *     username: "SomeUser",
+ * });
+ * ```
  */
 function getMembershipOutput(args, opts) {
     return pulumi.output(args).apply((a) => getMembership(a, opts));

package/getMembership.js.map

@@ -1 +1 @@
-{"version":3,"file":"getMembership.js","sourceRoot":"","sources":["../getMembership.ts"],"names":[],"mappings":";AAAA,wFAAwF;AACxF,iFAAiF;;;AAEjF,yCAAyC;AACzC,yCAAyC;AAEzC;;;;;GAKG;AACH,SAAgB,aAAa,CAAC,IAAuB,EAAE,IAA2B;IAE9E,IAAI,GAAG,MAAM,CAAC,YAAY,CAAC,SAAS,CAAC,oBAAoB,EAAE,EAAE,IAAI,IAAI,EAAE,CAAC,CAAC;IACzE,OAAO,MAAM,CAAC,OAAO,CAAC,MAAM,CAAC,0CAA0C,EAAE;QACrE,cAAc,EAAE,IAAI,CAAC,YAAY;QACjC,UAAU,EAAE,IAAI,CAAC,QAAQ;KAC5B,EAAE,IAAI,CAAC,CAAC;AACb,CAAC;AAPD,sCAOC;AA0CD;;;;;GAKG;AACH,SAAgB,mBAAmB,CAAC,IAA6B,EAAE,IAA2B;IAC1F,OAAO,MAAM,CAAC,MAAM,CAAC,IAAI,CAAC,CAAC,KAAK,CAAC,CAAC,CAAM,EAAE,EAAE,CAAC,aAAa,CAAC,CAAC,EAAE,IAAI,CAAC,CAAC,CAAA;AACxE,CAAC;AAFD,kDAEC"}
+{"version":3,"file":"getMembership.js","sourceRoot":"","sources":["../getMembership.ts"],"names":[],"mappings":";AAAA,wFAAwF;AACxF,iFAAiF;;;AAEjF,yCAAyC;AACzC,yCAAyC;AAEzC;;;;;;;;;;;;;;;;GAgBG;AACH,SAAgB,aAAa,CAAC,IAAuB,EAAE,IAA2B;IAE9E,IAAI,GAAG,MAAM,CAAC,YAAY,CAAC,SAAS,CAAC,oBAAoB,EAAE,EAAE,IAAI,IAAI,EAAE,CAAC,CAAC;IACzE,OAAO,MAAM,CAAC,OAAO,CAAC,MAAM,CAAC,0CAA0C,EAAE;QACrE,cAAc,EAAE,IAAI,CAAC,YAAY;QACjC,UAAU,EAAE,IAAI,CAAC,QAAQ;KAC5B,EAAE,IAAI,CAAC,CAAC;AACb,CAAC;AAPD,sCAOC;AA0CD;;;;;;;;;;;;;;;;GAgBG;AACH,SAAgB,mBAAmB,CAAC,IAA6B,EAAE,IAA2B;IAC1F,OAAO,MAAM,CAAC,MAAM,CAAC,IAAI,CAAC,CAAC,KAAK,CAAC,CAAC,CAAM,EAAE,EAAE,CAAC,aAAa,CAAC,CAAC,EAAE,IAAI,CAAC,CAAC,CAAA;AACxE,CAAC;AAFD,kDAEC"}

package/getOrganization.d.ts

@@ -1,6 +1,17 @@
 import * as pulumi from "@pulumi/pulumi";
 /**
  * Use this data source to retrieve basic information about a GitHub Organization.
+ *
+ * ## Example Usage
+ *
+ * ```typescript
+ * import * as pulumi from "@pulumi/pulumi";
+ * import * as github from "@pulumi/github";
+ *
+ * const example = github.getOrganization({
+ *     name: "github",
+ * });
+ * ```
  */
 export declare function getOrganization(args: GetOrganizationArgs, opts?: pulumi.InvokeOptions): Promise<GetOrganizationResult>;
 /**
@@ -135,6 +146,17 @@ export interface GetOrganizationResult {
 }
 /**
  * Use this data source to retrieve basic information about a GitHub Organization.
+ *
+ * ## Example Usage
+ *
+ * ```typescript
+ * import * as pulumi from "@pulumi/pulumi";
+ * import * as github from "@pulumi/github";
+ *
+ * const example = github.getOrganization({
+ *     name: "github",
+ * });
+ * ```
  */
 export declare function getOrganizationOutput(args: GetOrganizationOutputArgs, opts?: pulumi.InvokeOptions): pulumi.Output<GetOrganizationResult>;
 /**

package/getOrganization.js

@@ -7,6 +7,17 @@ const pulumi = require("@pulumi/pulumi");
 const utilities = require("./utilities");
 /**
  * Use this data source to retrieve basic information about a GitHub Organization.
+ *
+ * ## Example Usage
+ *
+ * ```typescript
+ * import * as pulumi from "@pulumi/pulumi";
+ * import * as github from "@pulumi/github";
+ *
+ * const example = github.getOrganization({
+ *     name: "github",
+ * });
+ * ```
  */
 function getOrganization(args, opts) {
     opts = pulumi.mergeOptions(utilities.resourceOptsDefaults(), opts || {});
@@ -17,6 +28,17 @@ function getOrganization(args, opts) {
 exports.getOrganization = getOrganization;
 /**
  * Use this data source to retrieve basic information about a GitHub Organization.
+ *
+ * ## Example Usage
+ *
+ * ```typescript
+ * import * as pulumi from "@pulumi/pulumi";
+ * import * as github from "@pulumi/github";
+ *
+ * const example = github.getOrganization({
+ *     name: "github",
+ * });
+ * ```
  */
 function getOrganizationOutput(args, opts) {
     return pulumi.output(args).apply((a) => getOrganization(a, opts));

package/getOrganization.js.map

@@ -1 +1 @@
-{"version":3,"file":"getOrganization.js","sourceRoot":"","sources":["../getOrganization.ts"],"names":[],"mappings":";AAAA,wFAAwF;AACxF,iFAAiF;;;AAEjF,yCAAyC;AACzC,yCAAyC;AAEzC;;GAEG;AACH,SAAgB,eAAe,CAAC,IAAyB,EAAE,IAA2B;IAElF,IAAI,GAAG,MAAM,CAAC,YAAY,CAAC,SAAS,CAAC,oBAAoB,EAAE,EAAE,IAAI,IAAI,EAAE,CAAC,CAAC;IACzE,OAAO,MAAM,CAAC,OAAO,CAAC,MAAM,CAAC,8CAA8C,EAAE;QACzE,MAAM,EAAE,IAAI,CAAC,IAAI;KACpB,EAAE,IAAI,CAAC,CAAC;AACb,CAAC;AAND,0CAMC;AAmID;;GAEG;AACH,SAAgB,qBAAqB,CAAC,IAA+B,EAAE,IAA2B;IAC9F,OAAO,MAAM,CAAC,MAAM,CAAC,IAAI,CAAC,CAAC,KAAK,CAAC,CAAC,CAAM,EAAE,EAAE,CAAC,eAAe,CAAC,CAAC,EAAE,IAAI,CAAC,CAAC,CAAA;AAC1E,CAAC;AAFD,sDAEC"}
+{"version":3,"file":"getOrganization.js","sourceRoot":"","sources":["../getOrganization.ts"],"names":[],"mappings":";AAAA,wFAAwF;AACxF,iFAAiF;;;AAEjF,yCAAyC;AACzC,yCAAyC;AAEzC;;;;;;;;;;;;;GAaG;AACH,SAAgB,eAAe,CAAC,IAAyB,EAAE,IAA2B;IAElF,IAAI,GAAG,MAAM,CAAC,YAAY,CAAC,SAAS,CAAC,oBAAoB,EAAE,EAAE,IAAI,IAAI,EAAE,CAAC,CAAC;IACzE,OAAO,MAAM,CAAC,OAAO,CAAC,MAAM,CAAC,8CAA8C,EAAE;QACzE,MAAM,EAAE,IAAI,CAAC,IAAI;KACpB,EAAE,IAAI,CAAC,CAAC;AACb,CAAC;AAND,0CAMC;AAmID;;;;;;;;;;;;;GAaG;AACH,SAAgB,qBAAqB,CAAC,IAA+B,EAAE,IAA2B;IAC9F,OAAO,MAAM,CAAC,MAAM,CAAC,IAAI,CAAC,CAAC,KAAK,CAAC,CAAC,CAAM,EAAE,EAAE,CAAC,eAAe,CAAC,CAAC,EAAE,IAAI,CAAC,CAAC,CAAA;AAC1E,CAAC;AAFD,sDAEC"}

package/getOrganizationCustomRole.d.ts

@@ -3,6 +3,17 @@ import * as pulumi from "@pulumi/pulumi";
  * Use this data source to retrieve information about a custom role in a GitHub Organization.
  *
  * > Note: Custom roles are currently only available in GitHub Enterprise Cloud.
+ *
+ * ## Example Usage
+ *
+ * ```typescript
+ * import * as pulumi from "@pulumi/pulumi";
+ * import * as github from "@pulumi/github";
+ *
+ * const example = github.getOrganizationCustomRole({
+ *     name: "example",
+ * });
+ * ```
  */
 export declare function getOrganizationCustomRole(args: GetOrganizationCustomRoleArgs, opts?: pulumi.InvokeOptions): Promise<GetOrganizationCustomRoleResult>;
 /**
@@ -40,6 +51,17 @@ export interface GetOrganizationCustomRoleResult {
  * Use this data source to retrieve information about a custom role in a GitHub Organization.
  *
  * > Note: Custom roles are currently only available in GitHub Enterprise Cloud.
+ *
+ * ## Example Usage
+ *
+ * ```typescript
+ * import * as pulumi from "@pulumi/pulumi";
+ * import * as github from "@pulumi/github";
+ *
+ * const example = github.getOrganizationCustomRole({
+ *     name: "example",
+ * });
+ * ```
  */
 export declare function getOrganizationCustomRoleOutput(args: GetOrganizationCustomRoleOutputArgs, opts?: pulumi.InvokeOptions): pulumi.Output<GetOrganizationCustomRoleResult>;
 /**

package/getOrganizationCustomRole.js

@@ -9,6 +9,17 @@ const utilities = require("./utilities");
  * Use this data source to retrieve information about a custom role in a GitHub Organization.
  *
  * > Note: Custom roles are currently only available in GitHub Enterprise Cloud.
+ *
+ * ## Example Usage
+ *
+ * ```typescript
+ * import * as pulumi from "@pulumi/pulumi";
+ * import * as github from "@pulumi/github";
+ *
+ * const example = github.getOrganizationCustomRole({
+ *     name: "example",
+ * });
+ * ```
  */
 function getOrganizationCustomRole(args, opts) {
     opts = pulumi.mergeOptions(utilities.resourceOptsDefaults(), opts || {});
@@ -21,6 +32,17 @@ exports.getOrganizationCustomRole = getOrganizationCustomRole;
  * Use this data source to retrieve information about a custom role in a GitHub Organization.
  *
  * > Note: Custom roles are currently only available in GitHub Enterprise Cloud.
+ *
+ * ## Example Usage
+ *
+ * ```typescript
+ * import * as pulumi from "@pulumi/pulumi";
+ * import * as github from "@pulumi/github";
+ *
+ * const example = github.getOrganizationCustomRole({
+ *     name: "example",
+ * });
+ * ```
  */
 function getOrganizationCustomRoleOutput(args, opts) {
     return pulumi.output(args).apply((a) => getOrganizationCustomRole(a, opts));

package/getOrganizationCustomRole.js.map

@@ -1 +1 @@
-{"version":3,"file":"getOrganizationCustomRole.js","sourceRoot":"","sources":["../getOrganizationCustomRole.ts"],"names":[],"mappings":";AAAA,wFAAwF;AACxF,iFAAiF;;;AAEjF,yCAAyC;AACzC,yCAAyC;AAEzC;;;;GAIG;AACH,SAAgB,yBAAyB,CAAC,IAAmC,EAAE,IAA2B;IAEtG,IAAI,GAAG,MAAM,CAAC,YAAY,CAAC,SAAS,CAAC,oBAAoB,EAAE,EAAE,IAAI,IAAI,EAAE,CAAC,CAAC;IACzE,OAAO,MAAM,CAAC,OAAO,CAAC,MAAM,CAAC,kEAAkE,EAAE;QAC7F,MAAM,EAAE,IAAI,CAAC,IAAI;KACpB,EAAE,IAAI,CAAC,CAAC;AACb,CAAC;AAND,8DAMC;AAkCD;;;;GAIG;AACH,SAAgB,+BAA+B,CAAC,IAAyC,EAAE,IAA2B;IAClH,OAAO,MAAM,CAAC,MAAM,CAAC,IAAI,CAAC,CAAC,KAAK,CAAC,CAAC,CAAM,EAAE,EAAE,CAAC,yBAAyB,CAAC,CAAC,EAAE,IAAI,CAAC,CAAC,CAAA;AACpF,CAAC;AAFD,0EAEC"}
+{"version":3,"file":"getOrganizationCustomRole.js","sourceRoot":"","sources":["../getOrganizationCustomRole.ts"],"names":[],"mappings":";AAAA,wFAAwF;AACxF,iFAAiF;;;AAEjF,yCAAyC;AACzC,yCAAyC;AAEzC;;;;;;;;;;;;;;;GAeG;AACH,SAAgB,yBAAyB,CAAC,IAAmC,EAAE,IAA2B;IAEtG,IAAI,GAAG,MAAM,CAAC,YAAY,CAAC,SAAS,CAAC,oBAAoB,EAAE,EAAE,IAAI,IAAI,EAAE,CAAC,CAAC;IACzE,OAAO,MAAM,CAAC,OAAO,CAAC,MAAM,CAAC,kEAAkE,EAAE;QAC7F,MAAM,EAAE,IAAI,CAAC,IAAI;KACpB,EAAE,IAAI,CAAC,CAAC;AACb,CAAC;AAND,8DAMC;AAkCD;;;;;;;;;;;;;;;GAeG;AACH,SAAgB,+BAA+B,CAAC,IAAyC,EAAE,IAA2B;IAClH,OAAO,MAAM,CAAC,MAAM,CAAC,IAAI,CAAC,CAAC,KAAK,CAAC,CAAC,CAAM,EAAE,EAAE,CAAC,yBAAyB,CAAC,CAAC,EAAE,IAAI,CAAC,CAAC,CAAA;AACpF,CAAC;AAFD,0EAEC"}

package/getOrganizationExternalIdentities.d.ts

@@ -3,6 +3,15 @@ import * as outputs from "./types/output";
 /**
  * Use this data source to retrieve each organization member's SAML or SCIM user
  * attributes.
+ *
+ * ## Example Usage
+ *
+ * ```typescript
+ * import * as pulumi from "@pulumi/pulumi";
+ * import * as github from "@pulumi/github";
+ *
+ * const all = github.getOrganizationExternalIdentities({});
+ * ```
  */
 export declare function getOrganizationExternalIdentities(opts?: pulumi.InvokeOptions): Promise<GetOrganizationExternalIdentitiesResult>;
 /**
@@ -21,5 +30,14 @@ export interface GetOrganizationExternalIdentitiesResult {
 /**
  * Use this data source to retrieve each organization member's SAML or SCIM user
  * attributes.
+ *
+ * ## Example Usage
+ *
+ * ```typescript
+ * import * as pulumi from "@pulumi/pulumi";
+ * import * as github from "@pulumi/github";
+ *
+ * const all = github.getOrganizationExternalIdentities({});
+ * ```
  */
 export declare function getOrganizationExternalIdentitiesOutput(opts?: pulumi.InvokeOptions): pulumi.Output<GetOrganizationExternalIdentitiesResult>;

package/getOrganizationExternalIdentities.js

@@ -8,6 +8,15 @@ const utilities = require("./utilities");
 /**
  * Use this data source to retrieve each organization member's SAML or SCIM user
  * attributes.
+ *
+ * ## Example Usage
+ *
+ * ```typescript
+ * import * as pulumi from "@pulumi/pulumi";
+ * import * as github from "@pulumi/github";
+ *
+ * const all = github.getOrganizationExternalIdentities({});
+ * ```
  */
 function getOrganizationExternalIdentities(opts) {
     opts = pulumi.mergeOptions(utilities.resourceOptsDefaults(), opts || {});
@@ -17,6 +26,15 @@ exports.getOrganizationExternalIdentities = getOrganizationExternalIdentities;
 /**
  * Use this data source to retrieve each organization member's SAML or SCIM user
  * attributes.
+ *
+ * ## Example Usage
+ *
+ * ```typescript
+ * import * as pulumi from "@pulumi/pulumi";
+ * import * as github from "@pulumi/github";
+ *
+ * const all = github.getOrganizationExternalIdentities({});
+ * ```
  */
 function getOrganizationExternalIdentitiesOutput(opts) {
     return pulumi.output(getOrganizationExternalIdentities(opts));

package/getOrganizationExternalIdentities.js.map

@@ -1 +1 @@
-{"version":3,"file":"getOrganizationExternalIdentities.js","sourceRoot":"","sources":["../getOrganizationExternalIdentities.ts"],"names":[],"mappings":";AAAA,wFAAwF;AACxF,iFAAiF;;;AAEjF,yCAAyC;AAGzC,yCAAyC;AAEzC;;;GAGG;AACH,SAAgB,iCAAiC,CAAC,IAA2B;IAEzE,IAAI,GAAG,MAAM,CAAC,YAAY,CAAC,SAAS,CAAC,oBAAoB,EAAE,EAAE,IAAI,IAAI,EAAE,CAAC,CAAC;IACzE,OAAO,MAAM,CAAC,OAAO,CAAC,MAAM,CAAC,kFAAkF,EAAE,EAChH,EAAE,IAAI,CAAC,CAAC;AACb,CAAC;AALD,8EAKC;AAeD;;;GAGG;AACH,SAAgB,uCAAuC,CAAC,IAA2B;IAC/E,OAAO,MAAM,CAAC,MAAM,CAAC,iCAAiC,CAAC,IAAI,CAAC,CAAC,CAAA;AACjE,CAAC;AAFD,0FAEC"}
+{"version":3,"file":"getOrganizationExternalIdentities.js","sourceRoot":"","sources":["../getOrganizationExternalIdentities.ts"],"names":[],"mappings":";AAAA,wFAAwF;AACxF,iFAAiF;;;AAEjF,yCAAyC;AAGzC,yCAAyC;AAEzC;;;;;;;;;;;;GAYG;AACH,SAAgB,iCAAiC,CAAC,IAA2B;IAEzE,IAAI,GAAG,MAAM,CAAC,YAAY,CAAC,SAAS,CAAC,oBAAoB,EAAE,EAAE,IAAI,IAAI,EAAE,CAAC,CAAC;IACzE,OAAO,MAAM,CAAC,OAAO,CAAC,MAAM,CAAC,kFAAkF,EAAE,EAChH,EAAE,IAAI,CAAC,CAAC;AACb,CAAC;AALD,8EAKC;AAeD;;;;;;;;;;;;GAYG;AACH,SAAgB,uCAAuC,CAAC,IAA2B;IAC/E,OAAO,MAAM,CAAC,MAAM,CAAC,iCAAiC,CAAC,IAAI,CAAC,CAAC,CAAA;AACjE,CAAC;AAFD,0FAEC"}

package/getOrganizationIpAllowList.d.ts

@@ -4,6 +4,15 @@ import * as outputs from "./types/output";
  * Use this data source to retrieve information about the IP allow list of an organization.
  * The allow list for IP addresses will block access to private resources via the web, API,
  * and Git from any IP addresses that are not on the allow list.
+ *
+ * ## Example Usage
+ *
+ * ```typescript
+ * import * as pulumi from "@pulumi/pulumi";
+ * import * as github from "@pulumi/github";
+ *
+ * const all = github.getOrganizationIpAllowList({});
+ * ```
  */
 export declare function getOrganizationIpAllowList(opts?: pulumi.InvokeOptions): Promise<GetOrganizationIpAllowListResult>;
 /**
@@ -24,5 +33,14 @@ export interface GetOrganizationIpAllowListResult {
  * Use this data source to retrieve information about the IP allow list of an organization.
  * The allow list for IP addresses will block access to private resources via the web, API,
  * and Git from any IP addresses that are not on the allow list.
+ *
+ * ## Example Usage
+ *
+ * ```typescript
+ * import * as pulumi from "@pulumi/pulumi";
+ * import * as github from "@pulumi/github";
+ *
+ * const all = github.getOrganizationIpAllowList({});
+ * ```
  */
 export declare function getOrganizationIpAllowListOutput(opts?: pulumi.InvokeOptions): pulumi.Output<GetOrganizationIpAllowListResult>;

package/getOrganizationIpAllowList.js

@@ -9,6 +9,15 @@ const utilities = require("./utilities");
  * Use this data source to retrieve information about the IP allow list of an organization.
  * The allow list for IP addresses will block access to private resources via the web, API,
  * and Git from any IP addresses that are not on the allow list.
+ *
+ * ## Example Usage
+ *
+ * ```typescript
+ * import * as pulumi from "@pulumi/pulumi";
+ * import * as github from "@pulumi/github";
+ *
+ * const all = github.getOrganizationIpAllowList({});
+ * ```
  */
 function getOrganizationIpAllowList(opts) {
     opts = pulumi.mergeOptions(utilities.resourceOptsDefaults(), opts || {});
@@ -19,6 +28,15 @@ exports.getOrganizationIpAllowList = getOrganizationIpAllowList;
  * Use this data source to retrieve information about the IP allow list of an organization.
  * The allow list for IP addresses will block access to private resources via the web, API,
  * and Git from any IP addresses that are not on the allow list.
+ *
+ * ## Example Usage
+ *
+ * ```typescript
+ * import * as pulumi from "@pulumi/pulumi";
+ * import * as github from "@pulumi/github";
+ *
+ * const all = github.getOrganizationIpAllowList({});
+ * ```
  */
 function getOrganizationIpAllowListOutput(opts) {
     return pulumi.output(getOrganizationIpAllowList(opts));

package/getOrganizationIpAllowList.js.map

@@ -1 +1 @@
-{"version":3,"file":"getOrganizationIpAllowList.js","sourceRoot":"","sources":["../getOrganizationIpAllowList.ts"],"names":[],"mappings":";AAAA,wFAAwF;AACxF,iFAAiF;;;AAEjF,yCAAyC;AAGzC,yCAAyC;AAEzC;;;;GAIG;AACH,SAAgB,0BAA0B,CAAC,IAA2B;IAElE,IAAI,GAAG,MAAM,CAAC,YAAY,CAAC,SAAS,CAAC,oBAAoB,EAAE,EAAE,IAAI,IAAI,EAAE,CAAC,CAAC;IACzE,OAAO,MAAM,CAAC,OAAO,CAAC,MAAM,CAAC,oEAAoE,EAAE,EAClG,EAAE,IAAI,CAAC,CAAC;AACb,CAAC;AALD,gEAKC;AAgBD;;;;GAIG;AACH,SAAgB,gCAAgC,CAAC,IAA2B;IACxE,OAAO,MAAM,CAAC,MAAM,CAAC,0BAA0B,CAAC,IAAI,CAAC,CAAC,CAAA;AAC1D,CAAC;AAFD,4EAEC"}
+{"version":3,"file":"getOrganizationIpAllowList.js","sourceRoot":"","sources":["../getOrganizationIpAllowList.ts"],"names":[],"mappings":";AAAA,wFAAwF;AACxF,iFAAiF;;;AAEjF,yCAAyC;AAGzC,yCAAyC;AAEzC;;;;;;;;;;;;;GAaG;AACH,SAAgB,0BAA0B,CAAC,IAA2B;IAElE,IAAI,GAAG,MAAM,CAAC,YAAY,CAAC,SAAS,CAAC,oBAAoB,EAAE,EAAE,IAAI,IAAI,EAAE,CAAC,CAAC;IACzE,OAAO,MAAM,CAAC,OAAO,CAAC,MAAM,CAAC,oEAAoE,EAAE,EAClG,EAAE,IAAI,CAAC,CAAC;AACb,CAAC;AALD,gEAKC;AAgBD;;;;;;;;;;;;;GAaG;AACH,SAAgB,gCAAgC,CAAC,IAA2B;IACxE,OAAO,MAAM,CAAC,MAAM,CAAC,0BAA0B,CAAC,IAAI,CAAC,CAAC,CAAA;AAC1D,CAAC;AAFD,4EAEC"}