@pulumi/github 5.1.0 → 5.2.0-alpha.1673638210

package/getRepositories.d.ts

@@ -1,10 +1,42 @@
 import * as pulumi from "@pulumi/pulumi";
+/**
+ * > **Note:** The data source will return a maximum of `1000` repositories
+ * 	[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>;
 /**
  * A collection of arguments for invoking getRepositories.
  */
 export interface GetRepositoriesArgs {
+    /**
+     * Returns a list of found repository IDs
+     */
+    includeRepoId?: boolean;
+    /**
+     * Search query. See [documentation for the search syntax](https://help.github.com/articles/understanding-the-search-syntax/).
+     */
     query: string;
+    /**
+     * Set the number of repositories requested per API call. Can be useful to decrease if requests are timing out or to increase to reduce the number of API calls. Defaults to 100.
+     */
+    resultsPerPage?: number;
+    /**
+     * Sorts the repositories returned by the specified attribute. Valid values include `stars`, `fork`, and `updated`. Defaults to `updated`.
+     */
     sort?: string;
 }
 /**
@@ -16,15 +48,53 @@ export interface GetRepositoriesResult {
      * The provider-assigned unique ID for this managed resource.
      */
     readonly id: string;
+    readonly includeRepoId?: boolean;
     readonly names: string[];
     readonly query: string;
+    /**
+     * (Optional) A list of found repository IDs (e.g. `449898861`)
+     */
+    readonly repoIds: number[];
+    readonly resultsPerPage?: number;
     readonly sort?: string;
 }
+/**
+ * > **Note:** The data source will return a maximum of `1000` repositories
+ * 	[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>;
 /**
  * A collection of arguments for invoking getRepositories.
  */
 export interface GetRepositoriesOutputArgs {
+    /**
+     * Returns a list of found repository IDs
+     */
+    includeRepoId?: pulumi.Input<boolean>;
+    /**
+     * Search query. See [documentation for the search syntax](https://help.github.com/articles/understanding-the-search-syntax/).
+     */
     query: pulumi.Input<string>;
+    /**
+     * Set the number of repositories requested per API call. Can be useful to decrease if requests are timing out or to increase to reduce the number of API calls. Defaults to 100.
+     */
+    resultsPerPage?: pulumi.Input<number>;
+    /**
+     * Sorts the repositories returned by the specified attribute. Valid values include `stars`, `fork`, and `updated`. Defaults to `updated`.
+     */
     sort?: pulumi.Input<string>;
 }

package/getRepositories.js

@@ -5,19 +5,54 @@ Object.defineProperty(exports, "__esModule", { value: true });
 exports.getRepositoriesOutput = exports.getRepositories = void 0;
 const pulumi = require("@pulumi/pulumi");
 const utilities = require("./utilities");
+/**
+ * > **Note:** The data source will return a maximum of `1000` repositories
+ * 	[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) {
-    if (!opts) {
-        opts = {};
-    }
-    opts = pulumi.mergeOptions(utilities.resourceOptsDefaults(), opts);
+    opts = pulumi.mergeOptions(utilities.resourceOptsDefaults(), opts || {});
     return pulumi.runtime.invoke("github:index/getRepositories:getRepositories", {
+        "includeRepoId": args.includeRepoId,
         "query": args.query,
+        "resultsPerPage": args.resultsPerPage,
         "sort": args.sort,
     }, opts);
 }
 exports.getRepositories = getRepositories;
+/**
+ * > **Note:** The data source will return a maximum of `1000` repositories
+ * 	[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));
+    return pulumi.output(args).apply((a) => getRepositories(a, opts));
 }
 exports.getRepositoriesOutput = getRepositoriesOutput;
 //# sourceMappingURL=getRepositories.js.map

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,SAAgB,eAAe,CAAC,IAAyB,EAAE,IAA2B;IAClF,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,8CAA8C,EAAE;QACzE,OAAO,EAAE,IAAI,CAAC,KAAK;QACnB,MAAM,EAAE,IAAI,CAAC,IAAI;KACpB,EAAE,IAAI,CAAC,CAAC;AACb,CAAC;AAVD,0CAUC;AAwBD,SAAgB,qBAAqB,CAAC,IAA+B,EAAE,IAA2B;IAC9F,OAAO,MAAM,CAAC,MAAM,CAAC,IAAI,CAAC,CAAC,KAAK,CAAC,CAAC,CAAC,EAAE,CAAC,eAAe,CAAC,CAAC,EAAE,IAAI,CAAC,CAAC,CAAA;AACnE,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

@@ -1,60 +1,201 @@
 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>;
 /**
  * A collection of arguments for invoking getRepository.
  */
 export interface GetRepositoryArgs {
+    /**
+     * A description of the repository.
+     */
     description?: string;
+    /**
+     * Full name of the repository (in `org/name` format).
+     */
     fullName?: string;
+    /**
+     * URL of a page describing the project.
+     */
     homepageUrl?: string;
+    /**
+     * The name of the repository.
+     */
     name?: string;
 }
 /**
  * A collection of values returned by getRepository.
  */
 export interface GetRepositoryResult {
+    /**
+     * Whether the repository allows auto-merging pull requests.
+     */
     readonly allowAutoMerge: boolean;
+    /**
+     * Whether the repository allows merge commits.
+     */
     readonly allowMergeCommit: boolean;
+    /**
+     * Whether the repository allows rebase merges.
+     */
     readonly allowRebaseMerge: boolean;
+    /**
+     * Whether the repository allows squash merges.
+     */
     readonly allowSquashMerge: boolean;
+    /**
+     * Whether the repository is archived.
+     */
     readonly archived: boolean;
+    /**
+     * The name of the default branch of the repository.
+     */
     readonly defaultBranch: string;
+    /**
+     * A description of the repository.
+     */
     readonly description?: string;
     readonly fullName: string;
+    /**
+     * URL that can be provided to `git clone` to clone the repository anonymously via the git protocol.
+     */
     readonly gitCloneUrl: string;
+    /**
+     * Whether the repository has Downloads feature enabled.
+     */
     readonly hasDownloads: boolean;
+    /**
+     * Whether the repository has GitHub Issues enabled.
+     */
     readonly hasIssues: boolean;
+    /**
+     * Whether the repository has the GitHub Projects enabled.
+     */
     readonly hasProjects: boolean;
+    /**
+     * Whether the repository has the GitHub Wiki enabled.
+     */
     readonly hasWiki: boolean;
+    /**
+     * URL of a page describing the project.
+     */
     readonly homepageUrl?: string;
+    /**
+     * URL to the repository on the web.
+     */
     readonly htmlUrl: string;
+    /**
+     * URL that can be provided to `git clone` to clone the repository via HTTPS.
+     */
     readonly httpCloneUrl: string;
     /**
      * The provider-assigned unique ID for this managed resource.
      */
     readonly id: string;
+    /**
+     * Whether the repository is a template repository.
+     */
+    readonly isTemplate: boolean;
+    /**
+     * The default value for a merge commit message.
+     */
     readonly mergeCommitMessage: string;
+    /**
+     * The default value for a merge commit title.
+     */
     readonly mergeCommitTitle: string;
     readonly name: string;
+    /**
+     * GraphQL global node id for use with v4 API
+     */
     readonly nodeId: string;
+    /**
+     * The repository's GitHub Pages configuration.
+     */
     readonly pages: outputs.GetRepositoryPage[];
+    /**
+     * Whether the repository is private.
+     */
     readonly private: boolean;
+    /**
+     * GitHub ID for the repository
+     */
     readonly repoId: number;
+    /**
+     * The default value for a squash merge commit message.
+     */
     readonly squashMergeCommitMessage: string;
+    /**
+     * The default value for a squash merge commit title.
+     */
     readonly squashMergeCommitTitle: string;
+    /**
+     * URL that can be provided to `git clone` to clone the repository via SSH.
+     */
     readonly sshCloneUrl: string;
+    /**
+     * URL that can be provided to `svn checkout` to check out the repository via GitHub's Subversion protocol emulation.
+     */
     readonly svnUrl: string;
+    /**
+     * The repository source template configuration.
+     */
+    readonly template: outputs.GetRepositoryTemplate;
+    /**
+     * The list of topics of the repository.
+     */
     readonly topics: string[];
+    /**
+     * Whether the repository is public, private or internal.
+     */
     readonly visibility: string;
 }
+/**
+ * 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>;
 /**
  * A collection of arguments for invoking getRepository.
  */
 export interface GetRepositoryOutputArgs {
+    /**
+     * A description of the repository.
+     */
     description?: pulumi.Input<string>;
+    /**
+     * Full name of the repository (in `org/name` format).
+     */
     fullName?: pulumi.Input<string>;
+    /**
+     * URL of a page describing the project.
+     */
     homepageUrl?: pulumi.Input<string>;
+    /**
+     * The name of the repository.
+     */
     name?: pulumi.Input<string>;
 }

package/getRepository.js

@@ -5,12 +5,23 @@ Object.defineProperty(exports, "__esModule", { value: true });
 exports.getRepositoryOutput = exports.getRepository = void 0;
 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 || {};
-    if (!opts) {
-        opts = {};
-    }
-    opts = pulumi.mergeOptions(utilities.resourceOptsDefaults(), opts);
+    opts = pulumi.mergeOptions(utilities.resourceOptsDefaults(), opts || {});
     return pulumi.runtime.invoke("github:index/getRepository:getRepository", {
         "description": args.description,
         "fullName": args.fullName,
@@ -19,8 +30,22 @@ function getRepository(args, opts) {
     }, 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));
+    return pulumi.output(args).apply((a) => getRepository(a, opts));
 }
 exports.getRepositoryOutput = getRepositoryOutput;
 //# sourceMappingURL=getRepository.js.map

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,SAAgB,aAAa,CAAC,IAAwB,EAAE,IAA2B;IAC/E,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,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;AAbD,sCAaC;AAmDD,SAAgB,mBAAmB,CAAC,IAA8B,EAAE,IAA2B;IAC3F,OAAO,MAAM,CAAC,MAAM,CAAC,IAAI,CAAC,CAAC,KAAK,CAAC,CAAC,CAAC,EAAE,CAAC,aAAa,CAAC,CAAC,EAAE,IAAI,CAAC,CAAC,CAAA;AACjE,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;AAuJD;;;;;;;;;;;;;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/getRepositoryBranches.d.ts

@@ -1,18 +1,44 @@
 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>;
 /**
  * A collection of arguments for invoking getRepositoryBranches.
  */
 export interface GetRepositoryBranchesArgs {
+    /**
+     * . If true, the `branches` attributes will be populated only with non protected branches. Default: `false`.
+     */
     onlyNonProtectedBranches?: boolean;
+    /**
+     * . If true, the `branches` attributes will be populated only with protected branches. Default: `false`.
+     */
     onlyProtectedBranches?: boolean;
+    /**
+     * Name of the repository to retrieve the branches from.
+     */
     repository: string;
 }
 /**
  * A collection of values returned by getRepositoryBranches.
  */
 export interface GetRepositoryBranchesResult {
+    /**
+     * The list of this repository's branches. Each element of `branches` has the following attributes:
+     */
     readonly branches: outputs.GetRepositoryBranchesBranch[];
     /**
      * The provider-assigned unique ID for this managed resource.
@@ -22,12 +48,35 @@ export interface GetRepositoryBranchesResult {
     readonly onlyProtectedBranches?: boolean;
     readonly repository: string;
 }
+/**
+ * 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>;
 /**
  * A collection of arguments for invoking getRepositoryBranches.
  */
 export interface GetRepositoryBranchesOutputArgs {
+    /**
+     * . If true, the `branches` attributes will be populated only with non protected branches. Default: `false`.
+     */
     onlyNonProtectedBranches?: pulumi.Input<boolean>;
+    /**
+     * . If true, the `branches` attributes will be populated only with protected branches. Default: `false`.
+     */
     onlyProtectedBranches?: pulumi.Input<boolean>;
+    /**
+     * Name of the repository to retrieve the branches from.
+     */
     repository: pulumi.Input<string>;
 }

package/getRepositoryBranches.js

@@ -5,11 +5,22 @@ Object.defineProperty(exports, "__esModule", { value: true });
 exports.getRepositoryBranchesOutput = exports.getRepositoryBranches = void 0;
 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) {
-    if (!opts) {
-        opts = {};
-    }
-    opts = pulumi.mergeOptions(utilities.resourceOptsDefaults(), opts);
+    opts = pulumi.mergeOptions(utilities.resourceOptsDefaults(), opts || {});
     return pulumi.runtime.invoke("github:index/getRepositoryBranches:getRepositoryBranches", {
         "onlyNonProtectedBranches": args.onlyNonProtectedBranches,
         "onlyProtectedBranches": args.onlyProtectedBranches,
@@ -17,8 +28,22 @@ function getRepositoryBranches(args, opts) {
     }, 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));
+    return pulumi.output(args).apply((a) => getRepositoryBranches(a, opts));
 }
 exports.getRepositoryBranchesOutput = getRepositoryBranchesOutput;
 //# sourceMappingURL=getRepositoryBranches.js.map

package/getRepositoryBranches.js.map

@@ -1 +1 @@
-{"version":3,"file":"getRepositoryBranches.js","sourceRoot":"","sources":["../getRepositoryBranches.ts"],"names":[],"mappings":";AAAA,wFAAwF;AACxF,iFAAiF;;;AAEjF,yCAAyC;AAGzC,yCAAyC;AAEzC,SAAgB,qBAAqB,CAAC,IAA+B,EAAE,IAA2B;IAC9F,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,0DAA0D,EAAE;QACrF,0BAA0B,EAAE,IAAI,CAAC,wBAAwB;QACzD,uBAAuB,EAAE,IAAI,CAAC,qBAAqB;QACnD,YAAY,EAAE,IAAI,CAAC,UAAU;KAChC,EAAE,IAAI,CAAC,CAAC;AACb,CAAC;AAXD,sDAWC;AAyBD,SAAgB,2BAA2B,CAAC,IAAqC,EAAE,IAA2B;IAC1G,OAAO,MAAM,CAAC,MAAM,CAAC,IAAI,CAAC,CAAC,KAAK,CAAC,CAAC,CAAC,EAAE,CAAC,qBAAqB,CAAC,CAAC,EAAE,IAAI,CAAC,CAAC,CAAA;AACzE,CAAC;AAFD,kEAEC"}
+{"version":3,"file":"getRepositoryBranches.js","sourceRoot":"","sources":["../getRepositoryBranches.ts"],"names":[],"mappings":";AAAA,wFAAwF;AACxF,iFAAiF;;;AAEjF,yCAAyC;AAGzC,yCAAyC;AAEzC;;;;;;;;;;;;;GAaG;AACH,SAAgB,qBAAqB,CAAC,IAA+B,EAAE,IAA2B;IAE9F,IAAI,GAAG,MAAM,CAAC,YAAY,CAAC,SAAS,CAAC,oBAAoB,EAAE,EAAE,IAAI,IAAI,EAAE,CAAC,CAAC;IACzE,OAAO,MAAM,CAAC,OAAO,CAAC,MAAM,CAAC,0DAA0D,EAAE;QACrF,0BAA0B,EAAE,IAAI,CAAC,wBAAwB;QACzD,uBAAuB,EAAE,IAAI,CAAC,qBAAqB;QACnD,YAAY,EAAE,IAAI,CAAC,UAAU;KAChC,EAAE,IAAI,CAAC,CAAC;AACb,CAAC;AARD,sDAQC;AAoCD;;;;;;;;;;;;;GAaG;AACH,SAAgB,2BAA2B,CAAC,IAAqC,EAAE,IAA2B;IAC1G,OAAO,MAAM,CAAC,MAAM,CAAC,IAAI,CAAC,CAAC,KAAK,CAAC,CAAC,CAAM,EAAE,EAAE,CAAC,qBAAqB,CAAC,CAAC,EAAE,IAAI,CAAC,CAAC,CAAA;AAChF,CAAC;AAFD,kEAEC"}

package/getRepositoryDeployKeys.d.ts

@@ -1,10 +1,27 @@
 import * as pulumi from "@pulumi/pulumi";
 import * as outputs from "./types/output";
+/**
+ * Use this data source to retrieve all deploy keys of a repository.
+ *
+ * ## Example Usage
+ *
+ * ```typescript
+ * import * as pulumi from "@pulumi/pulumi";
+ * import * as github from "@pulumi/github";
+ *
+ * const example = github.getRepositoryDeployKeys({
+ *     repository: "example-repository",
+ * });
+ * ```
+ */
 export declare function getRepositoryDeployKeys(args: GetRepositoryDeployKeysArgs, opts?: pulumi.InvokeOptions): Promise<GetRepositoryDeployKeysResult>;
 /**
  * A collection of arguments for invoking getRepositoryDeployKeys.
  */
 export interface GetRepositoryDeployKeysArgs {
+    /**
+     * Name of the repository to retrieve the branches from.
+     */
     repository: string;
 }
 /**
@@ -15,13 +32,33 @@ export interface GetRepositoryDeployKeysResult {
      * The provider-assigned unique ID for this managed resource.
      */
     readonly id: string;
+    /**
+     * The list of this repository's deploy keys. Each element of `keys` has the following attributes:
+     */
     readonly keys: outputs.GetRepositoryDeployKeysKey[];
     readonly repository: string;
 }
+/**
+ * Use this data source to retrieve all deploy keys of a repository.
+ *
+ * ## Example Usage
+ *
+ * ```typescript
+ * import * as pulumi from "@pulumi/pulumi";
+ * import * as github from "@pulumi/github";
+ *
+ * const example = github.getRepositoryDeployKeys({
+ *     repository: "example-repository",
+ * });
+ * ```
+ */
 export declare function getRepositoryDeployKeysOutput(args: GetRepositoryDeployKeysOutputArgs, opts?: pulumi.InvokeOptions): pulumi.Output<GetRepositoryDeployKeysResult>;
 /**
  * A collection of arguments for invoking getRepositoryDeployKeys.
  */
 export interface GetRepositoryDeployKeysOutputArgs {
+    /**
+     * Name of the repository to retrieve the branches from.
+     */
     repository: pulumi.Input<string>;
 }

package/getRepositoryDeployKeys.js

@@ -5,18 +5,43 @@ Object.defineProperty(exports, "__esModule", { value: true });
 exports.getRepositoryDeployKeysOutput = exports.getRepositoryDeployKeys = void 0;
 const pulumi = require("@pulumi/pulumi");
 const utilities = require("./utilities");
+/**
+ * Use this data source to retrieve all deploy keys of a repository.
+ *
+ * ## Example Usage
+ *
+ * ```typescript
+ * import * as pulumi from "@pulumi/pulumi";
+ * import * as github from "@pulumi/github";
+ *
+ * const example = github.getRepositoryDeployKeys({
+ *     repository: "example-repository",
+ * });
+ * ```
+ */
 function getRepositoryDeployKeys(args, opts) {
-    if (!opts) {
-        opts = {};
-    }
-    opts = pulumi.mergeOptions(utilities.resourceOptsDefaults(), opts);
+    opts = pulumi.mergeOptions(utilities.resourceOptsDefaults(), opts || {});
     return pulumi.runtime.invoke("github:index/getRepositoryDeployKeys:getRepositoryDeployKeys", {
         "repository": args.repository,
     }, opts);
 }
 exports.getRepositoryDeployKeys = getRepositoryDeployKeys;
+/**
+ * Use this data source to retrieve all deploy keys of a repository.
+ *
+ * ## Example Usage
+ *
+ * ```typescript
+ * import * as pulumi from "@pulumi/pulumi";
+ * import * as github from "@pulumi/github";
+ *
+ * const example = github.getRepositoryDeployKeys({
+ *     repository: "example-repository",
+ * });
+ * ```
+ */
 function getRepositoryDeployKeysOutput(args, opts) {
-    return pulumi.output(args).apply(a => getRepositoryDeployKeys(a, opts));
+    return pulumi.output(args).apply((a) => getRepositoryDeployKeys(a, opts));
 }
 exports.getRepositoryDeployKeysOutput = getRepositoryDeployKeysOutput;
 //# sourceMappingURL=getRepositoryDeployKeys.js.map

package/getRepositoryDeployKeys.js.map

@@ -1 +1 @@
-{"version":3,"file":"getRepositoryDeployKeys.js","sourceRoot":"","sources":["../getRepositoryDeployKeys.ts"],"names":[],"mappings":";AAAA,wFAAwF;AACxF,iFAAiF;;;AAEjF,yCAAyC;AAGzC,yCAAyC;AAEzC,SAAgB,uBAAuB,CAAC,IAAiC,EAAE,IAA2B;IAClG,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,8DAA8D,EAAE;QACzF,YAAY,EAAE,IAAI,CAAC,UAAU;KAChC,EAAE,IAAI,CAAC,CAAC;AACb,CAAC;AATD,0DASC;AAqBD,SAAgB,6BAA6B,CAAC,IAAuC,EAAE,IAA2B;IAC9G,OAAO,MAAM,CAAC,MAAM,CAAC,IAAI,CAAC,CAAC,KAAK,CAAC,CAAC,CAAC,EAAE,CAAC,uBAAuB,CAAC,CAAC,EAAE,IAAI,CAAC,CAAC,CAAA;AAC3E,CAAC;AAFD,sEAEC"}
+{"version":3,"file":"getRepositoryDeployKeys.js","sourceRoot":"","sources":["../getRepositoryDeployKeys.ts"],"names":[],"mappings":";AAAA,wFAAwF;AACxF,iFAAiF;;;AAEjF,yCAAyC;AAGzC,yCAAyC;AAEzC;;;;;;;;;;;;;GAaG;AACH,SAAgB,uBAAuB,CAAC,IAAiC,EAAE,IAA2B;IAElG,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;QACzF,YAAY,EAAE,IAAI,CAAC,UAAU;KAChC,EAAE,IAAI,CAAC,CAAC;AACb,CAAC;AAND,0DAMC;AA0BD;;;;;;;;;;;;;GAaG;AACH,SAAgB,6BAA6B,CAAC,IAAuC,EAAE,IAA2B;IAC9G,OAAO,MAAM,CAAC,MAAM,CAAC,IAAI,CAAC,CAAC,KAAK,CAAC,CAAC,CAAM,EAAE,EAAE,CAAC,uBAAuB,CAAC,CAAC,EAAE,IAAI,CAAC,CAAC,CAAA;AAClF,CAAC;AAFD,sEAEC"}