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

package/getOrganizationTeamSyncGroups.d.ts

@@ -2,6 +2,15 @@ import * as pulumi from "@pulumi/pulumi";
 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>;
 /**
@@ -19,5 +28,14 @@ export interface GetOrganizationTeamSyncGroupsResult {
 }
 /**
  * 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 getOrganizationTeamSyncGroupsOutput(opts?: pulumi.InvokeOptions): pulumi.Output<GetOrganizationTeamSyncGroupsResult>;

package/getOrganizationTeamSyncGroups.js

@@ -7,6 +7,15 @@ 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) {
     opts = pulumi.mergeOptions(utilities.resourceOptsDefaults(), opts || {});
@@ -15,6 +24,15 @@ function getOrganizationTeamSyncGroups(opts) {
 exports.getOrganizationTeamSyncGroups = getOrganizationTeamSyncGroups;
 /**
  * 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 getOrganizationTeamSyncGroupsOutput(opts) {
     return pulumi.output(getOrganizationTeamSyncGroups(opts));

package/getOrganizationTeamSyncGroups.js.map

@@ -1 +1 @@
-{"version":3,"file":"getOrganizationTeamSyncGroups.js","sourceRoot":"","sources":["../getOrganizationTeamSyncGroups.ts"],"names":[],"mappings":";AAAA,wFAAwF;AACxF,iFAAiF;;;AAEjF,yCAAyC;AAGzC,yCAAyC;AAEzC;;GAEG;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;AAeD;;GAEG;AACH,SAAgB,mCAAmC,CAAC,IAA2B;IAC3E,OAAO,MAAM,CAAC,MAAM,CAAC,6BAA6B,CAAC,IAAI,CAAC,CAAC,CAAA;AAC7D,CAAC;AAFD,kFAEC"}
+{"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;AAeD;;;;;;;;;;;GAWG;AACH,SAAgB,mCAAmC,CAAC,IAA2B;IAC3E,OAAO,MAAM,CAAC,MAAM,CAAC,6BAA6B,CAAC,IAAI,CAAC,CAAC,CAAA;AAC7D,CAAC;AAFD,kFAEC"}

package/getOrganizationTeams.d.ts

@@ -2,6 +2,28 @@ import * as pulumi from "@pulumi/pulumi";
 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>;
 /**
@@ -48,6 +70,28 @@ export interface GetOrganizationTeamsResult {
 }
 /**
  * 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>;
 /**

package/getOrganizationTeams.js

@@ -7,6 +7,28 @@ 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 || {};
@@ -20,6 +42,28 @@ function getOrganizationTeams(args, 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));

package/getOrganizationTeams.js.map

@@ -1 +1 @@
-{"version":3,"file":"getOrganizationTeams.js","sourceRoot":"","sources":["../getOrganizationTeams.ts"],"names":[],"mappings":";AAAA,wFAAwF;AACxF,iFAAiF;;;AAEjF,yCAAyC;AAGzC,yCAAyC;AAEzC;;GAEG;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;;GAEG;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"}
+{"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

@@ -2,6 +2,17 @@ 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>;
 /**
@@ -20,5 +31,16 @@ export interface GetOrganizationWebhooksResult {
 }
 /**
  * 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 getOrganizationWebhooksOutput(opts?: pulumi.InvokeOptions): pulumi.Output<GetOrganizationWebhooksResult>;

package/getOrganizationWebhooks.js

@@ -7,6 +7,17 @@ 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 || {});
@@ -15,6 +26,17 @@ function getOrganizationWebhooks(opts) {
 exports.getOrganizationWebhooks = getOrganizationWebhooks;
 /**
  * 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 getOrganizationWebhooksOutput(opts) {
     return pulumi.output(getOrganizationWebhooks(opts));

package/getOrganizationWebhooks.js.map

@@ -1 +1 @@
-{"version":3,"file":"getOrganizationWebhooks.js","sourceRoot":"","sources":["../getOrganizationWebhooks.ts"],"names":[],"mappings":";AAAA,wFAAwF;AACxF,iFAAiF;;;AAEjF,yCAAyC;AAGzC,yCAAyC;AAEzC;;GAEG;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;AAgBD;;GAEG;AACH,SAAgB,6BAA6B,CAAC,IAA2B;IACrE,OAAO,MAAM,CAAC,MAAM,CAAC,uBAAuB,CAAC,IAAI,CAAC,CAAC,CAAA;AACvD,CAAC;AAFD,sEAEC"}
+{"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;AAgBD;;;;;;;;;;;;;GAaG;AACH,SAAgB,6BAA6B,CAAC,IAA2B;IACrE,OAAO,MAAM,CAAC,MAAM,CAAC,uBAAuB,CAAC,IAAI,CAAC,CAAC,CAAA;AACvD,CAAC;AAFD,sEAEC"}

package/getRef.d.ts

@@ -1,6 +1,19 @@
 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({
+ *     owner: "example",
+ *     ref: "heads/development",
+ *     repository: "example",
+ * });
+ * ```
  */
 export declare function getRef(args: GetRefArgs, opts?: pulumi.InvokeOptions): Promise<GetRefResult>;
 /**
@@ -42,6 +55,19 @@ export interface GetRefResult {
 }
 /**
  * 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({
+ *     owner: "example",
+ *     ref: "heads/development",
+ *     repository: "example",
+ * });
+ * ```
  */
 export declare function getRefOutput(args: GetRefOutputArgs, opts?: pulumi.InvokeOptions): pulumi.Output<GetRefResult>;
 /**

package/getRef.js

@@ -7,6 +7,19 @@ 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({
+ *     owner: "example",
+ *     ref: "heads/development",
+ *     repository: "example",
+ * });
+ * ```
  */
 function getRef(args, opts) {
     opts = pulumi.mergeOptions(utilities.resourceOptsDefaults(), opts || {});
@@ -19,6 +32,19 @@ function getRef(args, 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({
+ *     owner: "example",
+ *     ref: "heads/development",
+ *     repository: "example",
+ * });
+ * ```
  */
 function getRefOutput(args, opts) {
     return pulumi.output(args).apply((a) => getRef(a, opts));

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;;GAEG;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,OAAO,EAAE,IAAI,CAAC,KAAK;QACnB,KAAK,EAAE,IAAI,CAAC,GAAG;QACf,YAAY,EAAE,IAAI,CAAC,UAAU;KAChC,EAAE,IAAI,CAAC,CAAC;AACb,CAAC;AARD,wBAQC;AAwCD;;GAEG;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"}
+{"version":3,"file":"getRef.js","sourceRoot":"","sources":["../getRef.ts"],"names":[],"mappings":";AAAA,wFAAwF;AACxF,iFAAiF;;;AAEjF,yCAAyC;AACzC,yCAAyC;AAEzC;;;;;;;;;;;;;;;GAeG;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,OAAO,EAAE,IAAI,CAAC,KAAK;QACnB,KAAK,EAAE,IAAI,CAAC,GAAG;QACf,YAAY,EAAE,IAAI,CAAC,UAAU;KAChC,EAAE,IAAI,CAAC,CAAC;AACb,CAAC;AARD,wBAQC;AAwCD;;;;;;;;;;;;;;;GAeG;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/getRepositories.d.ts

@@ -4,6 +4,18 @@ import * as pulumi from "@pulumi/pulumi";
  * 	[as documented in official API docs](https://developer.github.com/v3/search/#about-the-search-api).
  *
  * Use this data source to retrieve a list of GitHub repositories using a search query.
+ *
+ * ## Example Usage
+ *
+ * ```typescript
+ * import * as pulumi from "@pulumi/pulumi";
+ * import * as github from "@pulumi/github";
+ *
+ * const example = github.getRepositories({
+ *     includeRepoId: true,
+ *     query: "org:hashicorp language:Go",
+ * });
+ * ```
  */
 export declare function getRepositories(args: GetRepositoriesArgs, opts?: pulumi.InvokeOptions): Promise<GetRepositoriesResult>;
 /**
@@ -51,6 +63,18 @@ export interface GetRepositoriesResult {
  * 	[as documented in official API docs](https://developer.github.com/v3/search/#about-the-search-api).
  *
  * Use this data source to retrieve a list of GitHub repositories using a search query.
+ *
+ * ## Example Usage
+ *
+ * ```typescript
+ * import * as pulumi from "@pulumi/pulumi";
+ * import * as github from "@pulumi/github";
+ *
+ * const example = github.getRepositories({
+ *     includeRepoId: true,
+ *     query: "org:hashicorp language:Go",
+ * });
+ * ```
  */
 export declare function getRepositoriesOutput(args: GetRepositoriesOutputArgs, opts?: pulumi.InvokeOptions): pulumi.Output<GetRepositoriesResult>;
 /**

package/getRepositories.js

@@ -10,6 +10,18 @@ const utilities = require("./utilities");
  * 	[as documented in official API docs](https://developer.github.com/v3/search/#about-the-search-api).
  *
  * Use this data source to retrieve a list of GitHub repositories using a search query.
+ *
+ * ## Example Usage
+ *
+ * ```typescript
+ * import * as pulumi from "@pulumi/pulumi";
+ * import * as github from "@pulumi/github";
+ *
+ * const example = github.getRepositories({
+ *     includeRepoId: true,
+ *     query: "org:hashicorp language:Go",
+ * });
+ * ```
  */
 function getRepositories(args, opts) {
     opts = pulumi.mergeOptions(utilities.resourceOptsDefaults(), opts || {});
@@ -26,6 +38,18 @@ exports.getRepositories = getRepositories;
  * 	[as documented in official API docs](https://developer.github.com/v3/search/#about-the-search-api).
  *
  * Use this data source to retrieve a list of GitHub repositories using a search query.
+ *
+ * ## Example Usage
+ *
+ * ```typescript
+ * import * as pulumi from "@pulumi/pulumi";
+ * import * as github from "@pulumi/github";
+ *
+ * const example = github.getRepositories({
+ *     includeRepoId: true,
+ *     query: "org:hashicorp language:Go",
+ * });
+ * ```
  */
 function getRepositoriesOutput(args, opts) {
     return pulumi.output(args).apply((a) => getRepositories(a, opts));

package/getRepositories.js.map

@@ -1 +1 @@
-{"version":3,"file":"getRepositories.js","sourceRoot":"","sources":["../getRepositories.ts"],"names":[],"mappings":";AAAA,wFAAwF;AACxF,iFAAiF;;;AAEjF,yCAAyC;AACzC,yCAAyC;AAEzC;;;;;GAKG;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,eAAe,EAAE,IAAI,CAAC,aAAa;QACnC,OAAO,EAAE,IAAI,CAAC,KAAK;QACnB,gBAAgB,EAAE,IAAI,CAAC,cAAc;QACrC,MAAM,EAAE,IAAI,CAAC,IAAI;KACpB,EAAE,IAAI,CAAC,CAAC;AACb,CAAC;AATD,0CASC;AA2CD;;;;;GAKG;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":"getRepositories.js","sourceRoot":"","sources":["../getRepositories.ts"],"names":[],"mappings":";AAAA,wFAAwF;AACxF,iFAAiF;;;AAEjF,yCAAyC;AACzC,yCAAyC;AAEzC;;;;;;;;;;;;;;;;;GAiBG;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,eAAe,EAAE,IAAI,CAAC,aAAa;QACnC,OAAO,EAAE,IAAI,CAAC,KAAK;QACnB,gBAAgB,EAAE,IAAI,CAAC,cAAc;QACrC,MAAM,EAAE,IAAI,CAAC,IAAI;KACpB,EAAE,IAAI,CAAC,CAAC;AACb,CAAC;AATD,0CASC;AA2CD;;;;;;;;;;;;;;;;;GAiBG;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/getRepository.d.ts

@@ -2,6 +2,17 @@ import * as pulumi from "@pulumi/pulumi";
 import * as outputs from "./types/output";
 /**
  * Use this data source to retrieve information about a GitHub repository.
+ *
+ * ## Example Usage
+ *
+ * ```typescript
+ * import * as pulumi from "@pulumi/pulumi";
+ * import * as github from "@pulumi/github";
+ *
+ * const example = github.getRepository({
+ *     fullName: "hashicorp/terraform",
+ * });
+ * ```
  */
 export declare function getRepository(args?: GetRepositoryArgs, opts?: pulumi.InvokeOptions): Promise<GetRepositoryResult>;
 /**
@@ -166,6 +177,17 @@ export interface GetRepositoryResult {
 }
 /**
  * Use this data source to retrieve information about a GitHub repository.
+ *
+ * ## Example Usage
+ *
+ * ```typescript
+ * import * as pulumi from "@pulumi/pulumi";
+ * import * as github from "@pulumi/github";
+ *
+ * const example = github.getRepository({
+ *     fullName: "hashicorp/terraform",
+ * });
+ * ```
  */
 export declare function getRepositoryOutput(args?: GetRepositoryOutputArgs, opts?: pulumi.InvokeOptions): pulumi.Output<GetRepositoryResult>;
 /**

package/getRepository.js

@@ -7,6 +7,17 @@ const pulumi = require("@pulumi/pulumi");
 const utilities = require("./utilities");
 /**
  * Use this data source to retrieve information about a GitHub repository.
+ *
+ * ## Example Usage
+ *
+ * ```typescript
+ * import * as pulumi from "@pulumi/pulumi";
+ * import * as github from "@pulumi/github";
+ *
+ * const example = github.getRepository({
+ *     fullName: "hashicorp/terraform",
+ * });
+ * ```
  */
 function getRepository(args, opts) {
     args = args || {};
@@ -21,6 +32,17 @@ function getRepository(args, opts) {
 exports.getRepository = getRepository;
 /**
  * Use this data source to retrieve information about a GitHub repository.
+ *
+ * ## Example Usage
+ *
+ * ```typescript
+ * import * as pulumi from "@pulumi/pulumi";
+ * import * as github from "@pulumi/github";
+ *
+ * const example = github.getRepository({
+ *     fullName: "hashicorp/terraform",
+ * });
+ * ```
  */
 function getRepositoryOutput(args, opts) {
     return pulumi.output(args).apply((a) => getRepository(a, opts));

package/getRepository.js.map

@@ -1 +1 @@
-{"version":3,"file":"getRepository.js","sourceRoot":"","sources":["../getRepository.ts"],"names":[],"mappings":";AAAA,wFAAwF;AACxF,iFAAiF;;;AAEjF,yCAAyC;AAGzC,yCAAyC;AAEzC;;GAEG;AACH,SAAgB,aAAa,CAAC,IAAwB,EAAE,IAA2B;IAC/E,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,0CAA0C,EAAE;QACrE,aAAa,EAAE,IAAI,CAAC,WAAW;QAC/B,UAAU,EAAE,IAAI,CAAC,QAAQ;QACzB,aAAa,EAAE,IAAI,CAAC,WAAW;QAC/B,MAAM,EAAE,IAAI,CAAC,IAAI;KACpB,EAAE,IAAI,CAAC,CAAC;AACb,CAAC;AAVD,sCAUC;AAmKD;;GAEG;AACH,SAAgB,mBAAmB,CAAC,IAA8B,EAAE,IAA2B;IAC3F,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":"getRepository.js","sourceRoot":"","sources":["../getRepository.ts"],"names":[],"mappings":";AAAA,wFAAwF;AACxF,iFAAiF;;;AAEjF,yCAAyC;AAGzC,yCAAyC;AAEzC;;;;;;;;;;;;;GAaG;AACH,SAAgB,aAAa,CAAC,IAAwB,EAAE,IAA2B;IAC/E,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,0CAA0C,EAAE;QACrE,aAAa,EAAE,IAAI,CAAC,WAAW;QAC/B,UAAU,EAAE,IAAI,CAAC,QAAQ;QACzB,aAAa,EAAE,IAAI,CAAC,WAAW;QAC/B,MAAM,EAAE,IAAI,CAAC,IAAI;KACpB,EAAE,IAAI,CAAC,CAAC;AACb,CAAC;AAVD,sCAUC;AAmKD;;;;;;;;;;;;;GAaG;AACH,SAAgB,mBAAmB,CAAC,IAA8B,EAAE,IAA2B;IAC3F,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/getRepositoryAutolinkReferences.d.ts

@@ -2,6 +2,17 @@ import * as pulumi from "@pulumi/pulumi";
 import * as outputs from "./types/output";
 /**
  * Use this data source to retrieve autolink references for a repository.
+ *
+ * ## Example Usage
+ *
+ * ```typescript
+ * import * as pulumi from "@pulumi/pulumi";
+ * import * as github from "@pulumi/github";
+ *
+ * const example = github.getRepositoryAutolinkReferences({
+ *     repository: "example-repository",
+ * });
+ * ```
  */
 export declare function getRepositoryAutolinkReferences(args: GetRepositoryAutolinkReferencesArgs, opts?: pulumi.InvokeOptions): Promise<GetRepositoryAutolinkReferencesResult>;
 /**
@@ -29,6 +40,17 @@ export interface GetRepositoryAutolinkReferencesResult {
 }
 /**
  * Use this data source to retrieve autolink references for a repository.
+ *
+ * ## Example Usage
+ *
+ * ```typescript
+ * import * as pulumi from "@pulumi/pulumi";
+ * import * as github from "@pulumi/github";
+ *
+ * const example = github.getRepositoryAutolinkReferences({
+ *     repository: "example-repository",
+ * });
+ * ```
  */
 export declare function getRepositoryAutolinkReferencesOutput(args: GetRepositoryAutolinkReferencesOutputArgs, opts?: pulumi.InvokeOptions): pulumi.Output<GetRepositoryAutolinkReferencesResult>;
 /**

package/getRepositoryAutolinkReferences.js

@@ -7,6 +7,17 @@ const pulumi = require("@pulumi/pulumi");
 const utilities = require("./utilities");
 /**
  * Use this data source to retrieve autolink references for a repository.
+ *
+ * ## Example Usage
+ *
+ * ```typescript
+ * import * as pulumi from "@pulumi/pulumi";
+ * import * as github from "@pulumi/github";
+ *
+ * const example = github.getRepositoryAutolinkReferences({
+ *     repository: "example-repository",
+ * });
+ * ```
  */
 function getRepositoryAutolinkReferences(args, opts) {
     opts = pulumi.mergeOptions(utilities.resourceOptsDefaults(), opts || {});
@@ -17,6 +28,17 @@ function getRepositoryAutolinkReferences(args, opts) {
 exports.getRepositoryAutolinkReferences = getRepositoryAutolinkReferences;
 /**
  * Use this data source to retrieve autolink references for a repository.
+ *
+ * ## Example Usage
+ *
+ * ```typescript
+ * import * as pulumi from "@pulumi/pulumi";
+ * import * as github from "@pulumi/github";
+ *
+ * const example = github.getRepositoryAutolinkReferences({
+ *     repository: "example-repository",
+ * });
+ * ```
  */
 function getRepositoryAutolinkReferencesOutput(args, opts) {
     return pulumi.output(args).apply((a) => getRepositoryAutolinkReferences(a, opts));

package/getRepositoryAutolinkReferences.js.map

@@ -1 +1 @@
-{"version":3,"file":"getRepositoryAutolinkReferences.js","sourceRoot":"","sources":["../getRepositoryAutolinkReferences.ts"],"names":[],"mappings":";AAAA,wFAAwF;AACxF,iFAAiF;;;AAEjF,yCAAyC;AAGzC,yCAAyC;AAEzC;;GAEG;AACH,SAAgB,+BAA+B,CAAC,IAAyC,EAAE,IAA2B;IAElH,IAAI,GAAG,MAAM,CAAC,YAAY,CAAC,SAAS,CAAC,oBAAoB,EAAE,EAAE,IAAI,IAAI,EAAE,CAAC,CAAC;IACzE,OAAO,MAAM,CAAC,OAAO,CAAC,MAAM,CAAC,8EAA8E,EAAE;QACzG,YAAY,EAAE,IAAI,CAAC,UAAU;KAChC,EAAE,IAAI,CAAC,CAAC;AACb,CAAC;AAND,0EAMC;AA0BD;;GAEG;AACH,SAAgB,qCAAqC,CAAC,IAA+C,EAAE,IAA2B;IAC9H,OAAO,MAAM,CAAC,MAAM,CAAC,IAAI,CAAC,CAAC,KAAK,CAAC,CAAC,CAAM,EAAE,EAAE,CAAC,+BAA+B,CAAC,CAAC,EAAE,IAAI,CAAC,CAAC,CAAA;AAC1F,CAAC;AAFD,sFAEC"}
+{"version":3,"file":"getRepositoryAutolinkReferences.js","sourceRoot":"","sources":["../getRepositoryAutolinkReferences.ts"],"names":[],"mappings":";AAAA,wFAAwF;AACxF,iFAAiF;;;AAEjF,yCAAyC;AAGzC,yCAAyC;AAEzC;;;;;;;;;;;;;GAaG;AACH,SAAgB,+BAA+B,CAAC,IAAyC,EAAE,IAA2B;IAElH,IAAI,GAAG,MAAM,CAAC,YAAY,CAAC,SAAS,CAAC,oBAAoB,EAAE,EAAE,IAAI,IAAI,EAAE,CAAC,CAAC;IACzE,OAAO,MAAM,CAAC,OAAO,CAAC,MAAM,CAAC,8EAA8E,EAAE;QACzG,YAAY,EAAE,IAAI,CAAC,UAAU;KAChC,EAAE,IAAI,CAAC,CAAC;AACb,CAAC;AAND,0EAMC;AA0BD;;;;;;;;;;;;;GAaG;AACH,SAAgB,qCAAqC,CAAC,IAA+C,EAAE,IAA2B;IAC9H,OAAO,MAAM,CAAC,MAAM,CAAC,IAAI,CAAC,CAAC,KAAK,CAAC,CAAC,CAAM,EAAE,EAAE,CAAC,+BAA+B,CAAC,CAAC,EAAE,IAAI,CAAC,CAAC,CAAA;AAC1F,CAAC;AAFD,sFAEC"}

package/getRepositoryBranches.d.ts

@@ -2,6 +2,17 @@ import * as pulumi from "@pulumi/pulumi";
 import * as outputs from "./types/output";
 /**
  * Use this data source to retrieve information about branches in a repository.
+ *
+ * ## Example Usage
+ *
+ * ```typescript
+ * import * as pulumi from "@pulumi/pulumi";
+ * import * as github from "@pulumi/github";
+ *
+ * const example = github.getRepositoryBranches({
+ *     repository: "example-repository",
+ * });
+ * ```
  */
 export declare function getRepositoryBranches(args: GetRepositoryBranchesArgs, opts?: pulumi.InvokeOptions): Promise<GetRepositoryBranchesResult>;
 /**
@@ -39,6 +50,17 @@ export interface GetRepositoryBranchesResult {
 }
 /**
  * Use this data source to retrieve information about branches in a repository.
+ *
+ * ## Example Usage
+ *
+ * ```typescript
+ * import * as pulumi from "@pulumi/pulumi";
+ * import * as github from "@pulumi/github";
+ *
+ * const example = github.getRepositoryBranches({
+ *     repository: "example-repository",
+ * });
+ * ```
  */
 export declare function getRepositoryBranchesOutput(args: GetRepositoryBranchesOutputArgs, opts?: pulumi.InvokeOptions): pulumi.Output<GetRepositoryBranchesResult>;
 /**

package/getRepositoryBranches.js

@@ -7,6 +7,17 @@ const pulumi = require("@pulumi/pulumi");
 const utilities = require("./utilities");
 /**
  * Use this data source to retrieve information about branches in a repository.
+ *
+ * ## Example Usage
+ *
+ * ```typescript
+ * import * as pulumi from "@pulumi/pulumi";
+ * import * as github from "@pulumi/github";
+ *
+ * const example = github.getRepositoryBranches({
+ *     repository: "example-repository",
+ * });
+ * ```
  */
 function getRepositoryBranches(args, opts) {
     opts = pulumi.mergeOptions(utilities.resourceOptsDefaults(), opts || {});
@@ -19,6 +30,17 @@ function getRepositoryBranches(args, opts) {
 exports.getRepositoryBranches = getRepositoryBranches;
 /**
  * Use this data source to retrieve information about branches in a repository.
+ *
+ * ## Example Usage
+ *
+ * ```typescript
+ * import * as pulumi from "@pulumi/pulumi";
+ * import * as github from "@pulumi/github";
+ *
+ * const example = github.getRepositoryBranches({
+ *     repository: "example-repository",
+ * });
+ * ```
  */
 function getRepositoryBranchesOutput(args, opts) {
     return pulumi.output(args).apply((a) => getRepositoryBranches(a, opts));