@pulumi/github 5.1.0 → 5.2.0-alpha.1673638210

package/repositoryMilestone.d.ts

@@ -1,4 +1,31 @@
 import * as pulumi from "@pulumi/pulumi";
+/**
+ * Provides a GitHub repository milestone resource.
+ *
+ * This resource allows you to create and manage milestones for a GitHub Repository within an organization or user account.
+ *
+ * ## Example Usage
+ *
+ * ```typescript
+ * import * as pulumi from "@pulumi/pulumi";
+ * import * as github from "@pulumi/github";
+ *
+ * // Create a milestone for a repository
+ * const example = new github.RepositoryMilestone("example", {
+ *     owner: "example-owner",
+ *     repository: "example-repository",
+ *     title: "v1.1.0",
+ * });
+ * ```
+ *
+ * ## Import
+ *
+ * A GitHub Repository Milestone can be imported using an ID made up of `owner/repository/number`, e.g.
+ *
+ * ```sh
+ *  $ pulumi import github:index/repositoryMilestone:RepositoryMilestone example example-owner/example-repository/1
+ * ```
+ */
 export declare class RepositoryMilestone extends pulumi.CustomResource {
     /**
      * Get an existing RepositoryMilestone resource's state with the given name, ID, and optional extra
@@ -15,15 +42,33 @@ export declare class RepositoryMilestone extends pulumi.CustomResource {
      * when multiple copies of the Pulumi SDK have been loaded into the same process.
      */
     static isInstance(obj: any): obj is RepositoryMilestone;
+    /**
+     * A description of the milestone.
+     */
     readonly description: pulumi.Output<string | undefined>;
     /**
-     * in yyyy-mm-dd format
+     * The milestone due date. In `yyyy-mm-dd` format.
      */
     readonly dueDate: pulumi.Output<string | undefined>;
+    /**
+     * The number of the milestone.
+     */
     readonly number: pulumi.Output<number>;
+    /**
+     * The owner of the GitHub Repository.
+     */
     readonly owner: pulumi.Output<string>;
+    /**
+     * The name of the GitHub Repository.
+     */
     readonly repository: pulumi.Output<string>;
+    /**
+     * The state of the milestone. Either `open` or `closed`. Default: `open`
+     */
     readonly state: pulumi.Output<string | undefined>;
+    /**
+     * The title of the milestone.
+     */
     readonly title: pulumi.Output<string>;
     /**
      * Create a RepositoryMilestone resource with the given unique name, arguments, and options.
@@ -38,28 +83,61 @@ export declare class RepositoryMilestone extends pulumi.CustomResource {
  * Input properties used for looking up and filtering RepositoryMilestone resources.
  */
 export interface RepositoryMilestoneState {
+    /**
+     * A description of the milestone.
+     */
     description?: pulumi.Input<string>;
     /**
-     * in yyyy-mm-dd format
+     * The milestone due date. In `yyyy-mm-dd` format.
      */
     dueDate?: pulumi.Input<string>;
+    /**
+     * The number of the milestone.
+     */
     number?: pulumi.Input<number>;
+    /**
+     * The owner of the GitHub Repository.
+     */
     owner?: pulumi.Input<string>;
+    /**
+     * The name of the GitHub Repository.
+     */
     repository?: pulumi.Input<string>;
+    /**
+     * The state of the milestone. Either `open` or `closed`. Default: `open`
+     */
     state?: pulumi.Input<string>;
+    /**
+     * The title of the milestone.
+     */
     title?: pulumi.Input<string>;
 }
 /**
  * The set of arguments for constructing a RepositoryMilestone resource.
  */
 export interface RepositoryMilestoneArgs {
+    /**
+     * A description of the milestone.
+     */
     description?: pulumi.Input<string>;
     /**
-     * in yyyy-mm-dd format
+     * The milestone due date. In `yyyy-mm-dd` format.
      */
     dueDate?: pulumi.Input<string>;
+    /**
+     * The owner of the GitHub Repository.
+     */
     owner: pulumi.Input<string>;
+    /**
+     * The name of the GitHub Repository.
+     */
     repository: pulumi.Input<string>;
+    /**
+     * The state of the milestone. Either `open` or `closed`. Default: `open`
+     */
     state?: pulumi.Input<string>;
+    /**
+     * The title of the milestone.
+     */
     title: pulumi.Input<string>;
 }

package/repositoryMilestone.js

@@ -5,7 +5,56 @@ Object.defineProperty(exports, "__esModule", { value: true });
 exports.RepositoryMilestone = void 0;
 const pulumi = require("@pulumi/pulumi");
 const utilities = require("./utilities");
+/**
+ * Provides a GitHub repository milestone resource.
+ *
+ * This resource allows you to create and manage milestones for a GitHub Repository within an organization or user account.
+ *
+ * ## Example Usage
+ *
+ * ```typescript
+ * import * as pulumi from "@pulumi/pulumi";
+ * import * as github from "@pulumi/github";
+ *
+ * // Create a milestone for a repository
+ * const example = new github.RepositoryMilestone("example", {
+ *     owner: "example-owner",
+ *     repository: "example-repository",
+ *     title: "v1.1.0",
+ * });
+ * ```
+ *
+ * ## Import
+ *
+ * A GitHub Repository Milestone can be imported using an ID made up of `owner/repository/number`, e.g.
+ *
+ * ```sh
+ *  $ pulumi import github:index/repositoryMilestone:RepositoryMilestone example example-owner/example-repository/1
+ * ```
+ */
 class RepositoryMilestone extends pulumi.CustomResource {
+    /**
+     * Get an existing RepositoryMilestone resource's state with the given name, ID, and optional extra
+     * properties used to qualify the lookup.
+     *
+     * @param name The _unique_ name of the resulting resource.
+     * @param id The _unique_ provider ID of the resource to lookup.
+     * @param state Any extra arguments used during the lookup.
+     * @param opts Optional settings to control the behavior of the CustomResource.
+     */
+    static get(name, id, state, opts) {
+        return new RepositoryMilestone(name, state, Object.assign(Object.assign({}, opts), { id: id }));
+    }
+    /**
+     * Returns true if the given object is an instance of RepositoryMilestone.  This is designed to work even
+     * when multiple copies of the Pulumi SDK have been loaded into the same process.
+     */
+    static isInstance(obj) {
+        if (obj === undefined || obj === null) {
+            return false;
+        }
+        return obj['__pulumiType'] === RepositoryMilestone.__pulumiType;
+    }
     constructor(name, argsOrState, opts) {
         let resourceInputs = {};
         opts = opts || {};
@@ -41,28 +90,6 @@ class RepositoryMilestone extends pulumi.CustomResource {
         opts = pulumi.mergeOptions(utilities.resourceOptsDefaults(), opts);
         super(RepositoryMilestone.__pulumiType, name, resourceInputs, opts);
     }
-    /**
-     * Get an existing RepositoryMilestone resource's state with the given name, ID, and optional extra
-     * properties used to qualify the lookup.
-     *
-     * @param name The _unique_ name of the resulting resource.
-     * @param id The _unique_ provider ID of the resource to lookup.
-     * @param state Any extra arguments used during the lookup.
-     * @param opts Optional settings to control the behavior of the CustomResource.
-     */
-    static get(name, id, state, opts) {
-        return new RepositoryMilestone(name, state, Object.assign(Object.assign({}, opts), { id: id }));
-    }
-    /**
-     * Returns true if the given object is an instance of RepositoryMilestone.  This is designed to work even
-     * when multiple copies of the Pulumi SDK have been loaded into the same process.
-     */
-    static isInstance(obj) {
-        if (obj === undefined || obj === null) {
-            return false;
-        }
-        return obj['__pulumiType'] === RepositoryMilestone.__pulumiType;
-    }
 }
 exports.RepositoryMilestone = RepositoryMilestone;
 /** @internal */

package/repositoryMilestone.js.map

@@ -1 +1 @@
-{"version":3,"file":"repositoryMilestone.js","sourceRoot":"","sources":["../repositoryMilestone.ts"],"names":[],"mappings":";AAAA,wFAAwF;AACxF,iFAAiF;;;AAEjF,yCAAyC;AACzC,yCAAyC;AAEzC,MAAa,mBAAoB,SAAQ,MAAM,CAAC,cAAc;IA+C1D,YAAY,IAAY,EAAE,WAAgE,EAAE,IAAmC;QAC3H,IAAI,cAAc,GAAkB,EAAE,CAAC;QACvC,IAAI,GAAG,IAAI,IAAI,EAAE,CAAC;QAClB,IAAI,IAAI,CAAC,EAAE,EAAE;YACT,MAAM,KAAK,GAAG,WAAmD,CAAC;YAClE,cAAc,CAAC,aAAa,CAAC,GAAG,KAAK,CAAC,CAAC,CAAC,KAAK,CAAC,WAAW,CAAC,CAAC,CAAC,SAAS,CAAC;YACtE,cAAc,CAAC,SAAS,CAAC,GAAG,KAAK,CAAC,CAAC,CAAC,KAAK,CAAC,OAAO,CAAC,CAAC,CAAC,SAAS,CAAC;YAC9D,cAAc,CAAC,QAAQ,CAAC,GAAG,KAAK,CAAC,CAAC,CAAC,KAAK,CAAC,MAAM,CAAC,CAAC,CAAC,SAAS,CAAC;YAC5D,cAAc,CAAC,OAAO,CAAC,GAAG,KAAK,CAAC,CAAC,CAAC,KAAK,CAAC,KAAK,CAAC,CAAC,CAAC,SAAS,CAAC;YAC1D,cAAc,CAAC,YAAY,CAAC,GAAG,KAAK,CAAC,CAAC,CAAC,KAAK,CAAC,UAAU,CAAC,CAAC,CAAC,SAAS,CAAC;YACpE,cAAc,CAAC,OAAO,CAAC,GAAG,KAAK,CAAC,CAAC,CAAC,KAAK,CAAC,KAAK,CAAC,CAAC,CAAC,SAAS,CAAC;YAC1D,cAAc,CAAC,OAAO,CAAC,GAAG,KAAK,CAAC,CAAC,CAAC,KAAK,CAAC,KAAK,CAAC,CAAC,CAAC,SAAS,CAAC;SAC7D;aAAM;YACH,MAAM,IAAI,GAAG,WAAkD,CAAC;YAChE,IAAI,CAAC,CAAC,IAAI,IAAI,IAAI,CAAC,KAAK,KAAK,SAAS,CAAC,IAAI,CAAC,IAAI,CAAC,GAAG,EAAE;gBAClD,MAAM,IAAI,KAAK,CAAC,mCAAmC,CAAC,CAAC;aACxD;YACD,IAAI,CAAC,CAAC,IAAI,IAAI,IAAI,CAAC,UAAU,KAAK,SAAS,CAAC,IAAI,CAAC,IAAI,CAAC,GAAG,EAAE;gBACvD,MAAM,IAAI,KAAK,CAAC,wCAAwC,CAAC,CAAC;aAC7D;YACD,IAAI,CAAC,CAAC,IAAI,IAAI,IAAI,CAAC,KAAK,KAAK,SAAS,CAAC,IAAI,CAAC,IAAI,CAAC,GAAG,EAAE;gBAClD,MAAM,IAAI,KAAK,CAAC,mCAAmC,CAAC,CAAC;aACxD;YACD,cAAc,CAAC,aAAa,CAAC,GAAG,IAAI,CAAC,CAAC,CAAC,IAAI,CAAC,WAAW,CAAC,CAAC,CAAC,SAAS,CAAC;YACpE,cAAc,CAAC,SAAS,CAAC,GAAG,IAAI,CAAC,CAAC,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC,CAAC,SAAS,CAAC;YAC5D,cAAc,CAAC,OAAO,CAAC,GAAG,IAAI,CAAC,CAAC,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC,CAAC,SAAS,CAAC;YACxD,cAAc,CAAC,YAAY,CAAC,GAAG,IAAI,CAAC,CAAC,CAAC,IAAI,CAAC,UAAU,CAAC,CAAC,CAAC,SAAS,CAAC;YAClE,cAAc,CAAC,OAAO,CAAC,GAAG,IAAI,CAAC,CAAC,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC,CAAC,SAAS,CAAC;YACxD,cAAc,CAAC,OAAO,CAAC,GAAG,IAAI,CAAC,CAAC,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC,CAAC,SAAS,CAAC;YACxD,cAAc,CAAC,QAAQ,CAAC,GAAG,SAAS,CAAC,OAAO,CAAC;SAChD;QACD,IAAI,GAAG,MAAM,CAAC,YAAY,CAAC,SAAS,CAAC,oBAAoB,EAAE,EAAE,IAAI,CAAC,CAAC;QACnE,KAAK,CAAC,mBAAmB,CAAC,YAAY,EAAE,IAAI,EAAE,cAAc,EAAE,IAAI,CAAC,CAAC;IACxE,CAAC;IA/ED;;;;;;;;OAQG;IACI,MAAM,CAAC,GAAG,CAAC,IAAY,EAAE,EAA2B,EAAE,KAAgC,EAAE,IAAmC;QAC9H,OAAO,IAAI,mBAAmB,CAAC,IAAI,EAAO,KAAK,kCAAO,IAAI,KAAE,EAAE,EAAE,EAAE,IAAG,CAAC;IAC1E,CAAC;IAKD;;;OAGG;IACI,MAAM,CAAC,UAAU,CAAC,GAAQ;QAC7B,IAAI,GAAG,KAAK,SAAS,IAAI,GAAG,KAAK,IAAI,EAAE;YACnC,OAAO,KAAK,CAAC;SAChB;QACD,OAAO,GAAG,CAAC,cAAc,CAAC,KAAK,mBAAmB,CAAC,YAAY,CAAC;IACpE,CAAC;;AA1BL,kDAiFC;AAnEG,gBAAgB;AACO,gCAAY,GAAG,sDAAsD,CAAC"}
+{"version":3,"file":"repositoryMilestone.js","sourceRoot":"","sources":["../repositoryMilestone.ts"],"names":[],"mappings":";AAAA,wFAAwF;AACxF,iFAAiF;;;AAEjF,yCAAyC;AACzC,yCAAyC;AAEzC;;;;;;;;;;;;;;;;;;;;;;;;;;GA0BG;AACH,MAAa,mBAAoB,SAAQ,MAAM,CAAC,cAAc;IAC1D;;;;;;;;OAQG;IACI,MAAM,CAAC,GAAG,CAAC,IAAY,EAAE,EAA2B,EAAE,KAAgC,EAAE,IAAmC;QAC9H,OAAO,IAAI,mBAAmB,CAAC,IAAI,EAAO,KAAK,kCAAO,IAAI,KAAE,EAAE,EAAE,EAAE,IAAG,CAAC;IAC1E,CAAC;IAKD;;;OAGG;IACI,MAAM,CAAC,UAAU,CAAC,GAAQ;QAC7B,IAAI,GAAG,KAAK,SAAS,IAAI,GAAG,KAAK,IAAI,EAAE;YACnC,OAAO,KAAK,CAAC;SAChB;QACD,OAAO,GAAG,CAAC,cAAc,CAAC,KAAK,mBAAmB,CAAC,YAAY,CAAC;IACpE,CAAC;IAuCD,YAAY,IAAY,EAAE,WAAgE,EAAE,IAAmC;QAC3H,IAAI,cAAc,GAAkB,EAAE,CAAC;QACvC,IAAI,GAAG,IAAI,IAAI,EAAE,CAAC;QAClB,IAAI,IAAI,CAAC,EAAE,EAAE;YACT,MAAM,KAAK,GAAG,WAAmD,CAAC;YAClE,cAAc,CAAC,aAAa,CAAC,GAAG,KAAK,CAAC,CAAC,CAAC,KAAK,CAAC,WAAW,CAAC,CAAC,CAAC,SAAS,CAAC;YACtE,cAAc,CAAC,SAAS,CAAC,GAAG,KAAK,CAAC,CAAC,CAAC,KAAK,CAAC,OAAO,CAAC,CAAC,CAAC,SAAS,CAAC;YAC9D,cAAc,CAAC,QAAQ,CAAC,GAAG,KAAK,CAAC,CAAC,CAAC,KAAK,CAAC,MAAM,CAAC,CAAC,CAAC,SAAS,CAAC;YAC5D,cAAc,CAAC,OAAO,CAAC,GAAG,KAAK,CAAC,CAAC,CAAC,KAAK,CAAC,KAAK,CAAC,CAAC,CAAC,SAAS,CAAC;YAC1D,cAAc,CAAC,YAAY,CAAC,GAAG,KAAK,CAAC,CAAC,CAAC,KAAK,CAAC,UAAU,CAAC,CAAC,CAAC,SAAS,CAAC;YACpE,cAAc,CAAC,OAAO,CAAC,GAAG,KAAK,CAAC,CAAC,CAAC,KAAK,CAAC,KAAK,CAAC,CAAC,CAAC,SAAS,CAAC;YAC1D,cAAc,CAAC,OAAO,CAAC,GAAG,KAAK,CAAC,CAAC,CAAC,KAAK,CAAC,KAAK,CAAC,CAAC,CAAC,SAAS,CAAC;SAC7D;aAAM;YACH,MAAM,IAAI,GAAG,WAAkD,CAAC;YAChE,IAAI,CAAC,CAAC,IAAI,IAAI,IAAI,CAAC,KAAK,KAAK,SAAS,CAAC,IAAI,CAAC,IAAI,CAAC,GAAG,EAAE;gBAClD,MAAM,IAAI,KAAK,CAAC,mCAAmC,CAAC,CAAC;aACxD;YACD,IAAI,CAAC,CAAC,IAAI,IAAI,IAAI,CAAC,UAAU,KAAK,SAAS,CAAC,IAAI,CAAC,IAAI,CAAC,GAAG,EAAE;gBACvD,MAAM,IAAI,KAAK,CAAC,wCAAwC,CAAC,CAAC;aAC7D;YACD,IAAI,CAAC,CAAC,IAAI,IAAI,IAAI,CAAC,KAAK,KAAK,SAAS,CAAC,IAAI,CAAC,IAAI,CAAC,GAAG,EAAE;gBAClD,MAAM,IAAI,KAAK,CAAC,mCAAmC,CAAC,CAAC;aACxD;YACD,cAAc,CAAC,aAAa,CAAC,GAAG,IAAI,CAAC,CAAC,CAAC,IAAI,CAAC,WAAW,CAAC,CAAC,CAAC,SAAS,CAAC;YACpE,cAAc,CAAC,SAAS,CAAC,GAAG,IAAI,CAAC,CAAC,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC,CAAC,SAAS,CAAC;YAC5D,cAAc,CAAC,OAAO,CAAC,GAAG,IAAI,CAAC,CAAC,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC,CAAC,SAAS,CAAC;YACxD,cAAc,CAAC,YAAY,CAAC,GAAG,IAAI,CAAC,CAAC,CAAC,IAAI,CAAC,UAAU,CAAC,CAAC,CAAC,SAAS,CAAC;YAClE,cAAc,CAAC,OAAO,CAAC,GAAG,IAAI,CAAC,CAAC,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC,CAAC,SAAS,CAAC;YACxD,cAAc,CAAC,OAAO,CAAC,GAAG,IAAI,CAAC,CAAC,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC,CAAC,SAAS,CAAC;YACxD,cAAc,CAAC,QAAQ,CAAC,GAAG,SAAS,CAAC,OAAO,CAAC;SAChD;QACD,IAAI,GAAG,MAAM,CAAC,YAAY,CAAC,SAAS,CAAC,oBAAoB,EAAE,EAAE,IAAI,CAAC,CAAC;QACnE,KAAK,CAAC,mBAAmB,CAAC,YAAY,EAAE,IAAI,EAAE,cAAc,EAAE,IAAI,CAAC,CAAC;IACxE,CAAC;;AAlGL,kDAmGC;AArFG,gBAAgB;AACO,gCAAY,GAAG,sDAAsD,CAAC"}

package/repositoryProject.d.ts

@@ -1,4 +1,23 @@
 import * as pulumi from "@pulumi/pulumi";
+/**
+ * This resource allows you to create and manage projects for GitHub repository.
+ *
+ * ## Example Usage
+ *
+ * ```typescript
+ * import * as pulumi from "@pulumi/pulumi";
+ * import * as github from "@pulumi/github";
+ *
+ * const example = new github.Repository("example", {
+ *     description: "My awesome codebase",
+ *     hasProjects: true,
+ * });
+ * const project = new github.RepositoryProject("project", {
+ *     body: "This is a repository project.",
+ *     repository: example.name,
+ * });
+ * ```
+ */
 export declare class RepositoryProject extends pulumi.CustomResource {
     /**
      * Get an existing RepositoryProject resource's state with the given name, ID, and optional extra
@@ -15,10 +34,22 @@ export declare class RepositoryProject extends pulumi.CustomResource {
      * when multiple copies of the Pulumi SDK have been loaded into the same process.
      */
     static isInstance(obj: any): obj is RepositoryProject;
+    /**
+     * The body of the project.
+     */
     readonly body: pulumi.Output<string | undefined>;
     readonly etag: pulumi.Output<string>;
+    /**
+     * The name of the project.
+     */
     readonly name: pulumi.Output<string>;
+    /**
+     * The repository of the project.
+     */
     readonly repository: pulumi.Output<string>;
+    /**
+     * URL of the project
+     */
     readonly url: pulumi.Output<string>;
     /**
      * Create a RepositoryProject resource with the given unique name, arguments, and options.
@@ -33,17 +64,38 @@ export declare class RepositoryProject extends pulumi.CustomResource {
  * Input properties used for looking up and filtering RepositoryProject resources.
  */
 export interface RepositoryProjectState {
+    /**
+     * The body of the project.
+     */
     body?: pulumi.Input<string>;
     etag?: pulumi.Input<string>;
+    /**
+     * The name of the project.
+     */
     name?: pulumi.Input<string>;
+    /**
+     * The repository of the project.
+     */
     repository?: pulumi.Input<string>;
+    /**
+     * URL of the project
+     */
     url?: pulumi.Input<string>;
 }
 /**
  * The set of arguments for constructing a RepositoryProject resource.
  */
 export interface RepositoryProjectArgs {
+    /**
+     * The body of the project.
+     */
     body?: pulumi.Input<string>;
+    /**
+     * The name of the project.
+     */
     name?: pulumi.Input<string>;
+    /**
+     * The repository of the project.
+     */
     repository: pulumi.Input<string>;
 }

package/repositoryProject.js

@@ -5,7 +5,48 @@ Object.defineProperty(exports, "__esModule", { value: true });
 exports.RepositoryProject = void 0;
 const pulumi = require("@pulumi/pulumi");
 const utilities = require("./utilities");
+/**
+ * This resource allows you to create and manage projects for GitHub repository.
+ *
+ * ## Example Usage
+ *
+ * ```typescript
+ * import * as pulumi from "@pulumi/pulumi";
+ * import * as github from "@pulumi/github";
+ *
+ * const example = new github.Repository("example", {
+ *     description: "My awesome codebase",
+ *     hasProjects: true,
+ * });
+ * const project = new github.RepositoryProject("project", {
+ *     body: "This is a repository project.",
+ *     repository: example.name,
+ * });
+ * ```
+ */
 class RepositoryProject extends pulumi.CustomResource {
+    /**
+     * Get an existing RepositoryProject resource's state with the given name, ID, and optional extra
+     * properties used to qualify the lookup.
+     *
+     * @param name The _unique_ name of the resulting resource.
+     * @param id The _unique_ provider ID of the resource to lookup.
+     * @param state Any extra arguments used during the lookup.
+     * @param opts Optional settings to control the behavior of the CustomResource.
+     */
+    static get(name, id, state, opts) {
+        return new RepositoryProject(name, state, Object.assign(Object.assign({}, opts), { id: id }));
+    }
+    /**
+     * Returns true if the given object is an instance of RepositoryProject.  This is designed to work even
+     * when multiple copies of the Pulumi SDK have been loaded into the same process.
+     */
+    static isInstance(obj) {
+        if (obj === undefined || obj === null) {
+            return false;
+        }
+        return obj['__pulumiType'] === RepositoryProject.__pulumiType;
+    }
     constructor(name, argsOrState, opts) {
         let resourceInputs = {};
         opts = opts || {};
@@ -31,28 +72,6 @@ class RepositoryProject extends pulumi.CustomResource {
         opts = pulumi.mergeOptions(utilities.resourceOptsDefaults(), opts);
         super(RepositoryProject.__pulumiType, name, resourceInputs, opts);
     }
-    /**
-     * Get an existing RepositoryProject resource's state with the given name, ID, and optional extra
-     * properties used to qualify the lookup.
-     *
-     * @param name The _unique_ name of the resulting resource.
-     * @param id The _unique_ provider ID of the resource to lookup.
-     * @param state Any extra arguments used during the lookup.
-     * @param opts Optional settings to control the behavior of the CustomResource.
-     */
-    static get(name, id, state, opts) {
-        return new RepositoryProject(name, state, Object.assign(Object.assign({}, opts), { id: id }));
-    }
-    /**
-     * Returns true if the given object is an instance of RepositoryProject.  This is designed to work even
-     * when multiple copies of the Pulumi SDK have been loaded into the same process.
-     */
-    static isInstance(obj) {
-        if (obj === undefined || obj === null) {
-            return false;
-        }
-        return obj['__pulumiType'] === RepositoryProject.__pulumiType;
-    }
 }
 exports.RepositoryProject = RepositoryProject;
 /** @internal */

package/repositoryProject.js.map

@@ -1 +1 @@
-{"version":3,"file":"repositoryProject.js","sourceRoot":"","sources":["../repositoryProject.ts"],"names":[],"mappings":";AAAA,wFAAwF;AACxF,iFAAiF;;;AAEjF,yCAAyC;AACzC,yCAAyC;AAEzC,MAAa,iBAAkB,SAAQ,MAAM,CAAC,cAAc;IA0CxD,YAAY,IAAY,EAAE,WAA4D,EAAE,IAAmC;QACvH,IAAI,cAAc,GAAkB,EAAE,CAAC;QACvC,IAAI,GAAG,IAAI,IAAI,EAAE,CAAC;QAClB,IAAI,IAAI,CAAC,EAAE,EAAE;YACT,MAAM,KAAK,GAAG,WAAiD,CAAC;YAChE,cAAc,CAAC,MAAM,CAAC,GAAG,KAAK,CAAC,CAAC,CAAC,KAAK,CAAC,IAAI,CAAC,CAAC,CAAC,SAAS,CAAC;YACxD,cAAc,CAAC,MAAM,CAAC,GAAG,KAAK,CAAC,CAAC,CAAC,KAAK,CAAC,IAAI,CAAC,CAAC,CAAC,SAAS,CAAC;YACxD,cAAc,CAAC,MAAM,CAAC,GAAG,KAAK,CAAC,CAAC,CAAC,KAAK,CAAC,IAAI,CAAC,CAAC,CAAC,SAAS,CAAC;YACxD,cAAc,CAAC,YAAY,CAAC,GAAG,KAAK,CAAC,CAAC,CAAC,KAAK,CAAC,UAAU,CAAC,CAAC,CAAC,SAAS,CAAC;YACpE,cAAc,CAAC,KAAK,CAAC,GAAG,KAAK,CAAC,CAAC,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC,CAAC,SAAS,CAAC;SACzD;aAAM;YACH,MAAM,IAAI,GAAG,WAAgD,CAAC;YAC9D,IAAI,CAAC,CAAC,IAAI,IAAI,IAAI,CAAC,UAAU,KAAK,SAAS,CAAC,IAAI,CAAC,IAAI,CAAC,GAAG,EAAE;gBACvD,MAAM,IAAI,KAAK,CAAC,wCAAwC,CAAC,CAAC;aAC7D;YACD,cAAc,CAAC,MAAM,CAAC,GAAG,IAAI,CAAC,CAAC,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC,CAAC,SAAS,CAAC;YACtD,cAAc,CAAC,MAAM,CAAC,GAAG,IAAI,CAAC,CAAC,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC,CAAC,SAAS,CAAC;YACtD,cAAc,CAAC,YAAY,CAAC,GAAG,IAAI,CAAC,CAAC,CAAC,IAAI,CAAC,UAAU,CAAC,CAAC,CAAC,SAAS,CAAC;YAClE,cAAc,CAAC,MAAM,CAAC,GAAG,SAAS,CAAC,OAAO,CAAC;YAC3C,cAAc,CAAC,KAAK,CAAC,GAAG,SAAS,CAAC,OAAO,CAAC;SAC7C;QACD,IAAI,GAAG,MAAM,CAAC,YAAY,CAAC,SAAS,CAAC,oBAAoB,EAAE,EAAE,IAAI,CAAC,CAAC;QACnE,KAAK,CAAC,iBAAiB,CAAC,YAAY,EAAE,IAAI,EAAE,cAAc,EAAE,IAAI,CAAC,CAAC;IACtE,CAAC;IAhED;;;;;;;;OAQG;IACI,MAAM,CAAC,GAAG,CAAC,IAAY,EAAE,EAA2B,EAAE,KAA8B,EAAE,IAAmC;QAC5H,OAAO,IAAI,iBAAiB,CAAC,IAAI,EAAO,KAAK,kCAAO,IAAI,KAAE,EAAE,EAAE,EAAE,IAAG,CAAC;IACxE,CAAC;IAKD;;;OAGG;IACI,MAAM,CAAC,UAAU,CAAC,GAAQ;QAC7B,IAAI,GAAG,KAAK,SAAS,IAAI,GAAG,KAAK,IAAI,EAAE;YACnC,OAAO,KAAK,CAAC;SAChB;QACD,OAAO,GAAG,CAAC,cAAc,CAAC,KAAK,iBAAiB,CAAC,YAAY,CAAC;IAClE,CAAC;;AA1BL,8CAkEC;AApDG,gBAAgB;AACO,8BAAY,GAAG,kDAAkD,CAAC"}
+{"version":3,"file":"repositoryProject.js","sourceRoot":"","sources":["../repositoryProject.ts"],"names":[],"mappings":";AAAA,wFAAwF;AACxF,iFAAiF;;;AAEjF,yCAAyC;AACzC,yCAAyC;AAEzC;;;;;;;;;;;;;;;;;;GAkBG;AACH,MAAa,iBAAkB,SAAQ,MAAM,CAAC,cAAc;IACxD;;;;;;;;OAQG;IACI,MAAM,CAAC,GAAG,CAAC,IAAY,EAAE,EAA2B,EAAE,KAA8B,EAAE,IAAmC;QAC5H,OAAO,IAAI,iBAAiB,CAAC,IAAI,EAAO,KAAK,kCAAO,IAAI,KAAE,EAAE,EAAE,EAAE,IAAG,CAAC;IACxE,CAAC;IAKD;;;OAGG;IACI,MAAM,CAAC,UAAU,CAAC,GAAQ;QAC7B,IAAI,GAAG,KAAK,SAAS,IAAI,GAAG,KAAK,IAAI,EAAE;YACnC,OAAO,KAAK,CAAC;SAChB;QACD,OAAO,GAAG,CAAC,cAAc,CAAC,KAAK,iBAAiB,CAAC,YAAY,CAAC;IAClE,CAAC;IA4BD,YAAY,IAAY,EAAE,WAA4D,EAAE,IAAmC;QACvH,IAAI,cAAc,GAAkB,EAAE,CAAC;QACvC,IAAI,GAAG,IAAI,IAAI,EAAE,CAAC;QAClB,IAAI,IAAI,CAAC,EAAE,EAAE;YACT,MAAM,KAAK,GAAG,WAAiD,CAAC;YAChE,cAAc,CAAC,MAAM,CAAC,GAAG,KAAK,CAAC,CAAC,CAAC,KAAK,CAAC,IAAI,CAAC,CAAC,CAAC,SAAS,CAAC;YACxD,cAAc,CAAC,MAAM,CAAC,GAAG,KAAK,CAAC,CAAC,CAAC,KAAK,CAAC,IAAI,CAAC,CAAC,CAAC,SAAS,CAAC;YACxD,cAAc,CAAC,MAAM,CAAC,GAAG,KAAK,CAAC,CAAC,CAAC,KAAK,CAAC,IAAI,CAAC,CAAC,CAAC,SAAS,CAAC;YACxD,cAAc,CAAC,YAAY,CAAC,GAAG,KAAK,CAAC,CAAC,CAAC,KAAK,CAAC,UAAU,CAAC,CAAC,CAAC,SAAS,CAAC;YACpE,cAAc,CAAC,KAAK,CAAC,GAAG,KAAK,CAAC,CAAC,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC,CAAC,SAAS,CAAC;SACzD;aAAM;YACH,MAAM,IAAI,GAAG,WAAgD,CAAC;YAC9D,IAAI,CAAC,CAAC,IAAI,IAAI,IAAI,CAAC,UAAU,KAAK,SAAS,CAAC,IAAI,CAAC,IAAI,CAAC,GAAG,EAAE;gBACvD,MAAM,IAAI,KAAK,CAAC,wCAAwC,CAAC,CAAC;aAC7D;YACD,cAAc,CAAC,MAAM,CAAC,GAAG,IAAI,CAAC,CAAC,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC,CAAC,SAAS,CAAC;YACtD,cAAc,CAAC,MAAM,CAAC,GAAG,IAAI,CAAC,CAAC,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC,CAAC,SAAS,CAAC;YACtD,cAAc,CAAC,YAAY,CAAC,GAAG,IAAI,CAAC,CAAC,CAAC,IAAI,CAAC,UAAU,CAAC,CAAC,CAAC,SAAS,CAAC;YAClE,cAAc,CAAC,MAAM,CAAC,GAAG,SAAS,CAAC,OAAO,CAAC;YAC3C,cAAc,CAAC,KAAK,CAAC,GAAG,SAAS,CAAC,OAAO,CAAC;SAC7C;QACD,IAAI,GAAG,MAAM,CAAC,YAAY,CAAC,SAAS,CAAC,oBAAoB,EAAE,EAAE,IAAI,CAAC,CAAC;QACnE,KAAK,CAAC,iBAAiB,CAAC,YAAY,EAAE,IAAI,EAAE,cAAc,EAAE,IAAI,CAAC,CAAC;IACtE,CAAC;;AA7EL,8CA8EC;AAhEG,gBAAgB;AACO,8BAAY,GAAG,kDAAkD,CAAC"}

package/repositoryPullRequest.d.ts

@@ -1,4 +1,22 @@
 import * as pulumi from "@pulumi/pulumi";
+/**
+ * This resource allows you to create and manage PullRequests for repositories within your GitHub organization or personal account.
+ *
+ * ## Example Usage
+ *
+ * ```typescript
+ * import * as pulumi from "@pulumi/pulumi";
+ * import * as github from "@pulumi/github";
+ *
+ * const example = new github.RepositoryPullRequest("example", {
+ *     baseRef: "main",
+ *     baseRepository: "example-repository",
+ *     body: "This will change everything",
+ *     headRef: "feature-branch",
+ *     title: "My newest feature",
+ * });
+ * ```
+ */
 export declare class RepositoryPullRequest extends pulumi.CustomResource {
     /**
      * Get an existing RepositoryPullRequest resource's state with the given name, ID, and optional extra
@@ -15,27 +33,69 @@ export declare class RepositoryPullRequest extends pulumi.CustomResource {
      * when multiple copies of the Pulumi SDK have been loaded into the same process.
      */
     static isInstance(obj: any): obj is RepositoryPullRequest;
+    /**
+     * Name of the branch serving as the base of the Pull Request.
+     */
     readonly baseRef: pulumi.Output<string>;
+    /**
+     * Name of the base repository to retrieve the Pull Requests from.
+     */
     readonly baseRepository: pulumi.Output<string>;
+    /**
+     * Head commit SHA of the Pull Request base.
+     */
     readonly baseSha: pulumi.Output<string>;
+    /**
+     * Body of the Pull Request.
+     */
     readonly body: pulumi.Output<string | undefined>;
+    /**
+     * Indicates Whether this Pull Request is a draft.
+     */
     readonly draft: pulumi.Output<boolean>;
+    /**
+     * Name of the branch serving as the head of the Pull Request.
+     */
     readonly headRef: pulumi.Output<string>;
+    /**
+     * Head commit SHA of the Pull Request head.
+     */
     readonly headSha: pulumi.Output<string>;
     /**
-     * List of names of labels on the PR
+     * List of label names set on the Pull Request.
      */
     readonly labels: pulumi.Output<string[]>;
+    /**
+     * Controls whether the base repository maintainers can modify the Pull Request. Default: false.
+     */
     readonly maintainerCanModify: pulumi.Output<boolean | undefined>;
+    /**
+     * The number of the Pull Request within the repository.
+     */
     readonly number: pulumi.Output<number>;
+    /**
+     * Unix timestamp indicating the Pull Request creation time.
+     */
     readonly openedAt: pulumi.Output<number>;
     /**
-     * Username of the PR creator
+     * GitHub login of the user who opened the Pull Request.
      */
     readonly openedBy: pulumi.Output<string>;
+    /**
+     * Owner of the repository. If not provided, the provider's default owner is used.
+     */
     readonly owner: pulumi.Output<string | undefined>;
+    /**
+     * the current Pull Request state - can be "open", "closed" or "merged".
+     */
     readonly state: pulumi.Output<string>;
+    /**
+     * The title of the Pull Request.
+     */
     readonly title: pulumi.Output<string>;
+    /**
+     * The timestamp of the last Pull Request update.
+     */
     readonly updatedAt: pulumi.Output<number>;
     /**
      * Create a RepositoryPullRequest resource with the given unique name, arguments, and options.
@@ -50,38 +110,101 @@ export declare class RepositoryPullRequest extends pulumi.CustomResource {
  * Input properties used for looking up and filtering RepositoryPullRequest resources.
  */
 export interface RepositoryPullRequestState {
+    /**
+     * Name of the branch serving as the base of the Pull Request.
+     */
     baseRef?: pulumi.Input<string>;
+    /**
+     * Name of the base repository to retrieve the Pull Requests from.
+     */
     baseRepository?: pulumi.Input<string>;
+    /**
+     * Head commit SHA of the Pull Request base.
+     */
     baseSha?: pulumi.Input<string>;
+    /**
+     * Body of the Pull Request.
+     */
     body?: pulumi.Input<string>;
+    /**
+     * Indicates Whether this Pull Request is a draft.
+     */
     draft?: pulumi.Input<boolean>;
+    /**
+     * Name of the branch serving as the head of the Pull Request.
+     */
     headRef?: pulumi.Input<string>;
+    /**
+     * Head commit SHA of the Pull Request head.
+     */
     headSha?: pulumi.Input<string>;
     /**
-     * List of names of labels on the PR
+     * List of label names set on the Pull Request.
      */
     labels?: pulumi.Input<pulumi.Input<string>[]>;
+    /**
+     * Controls whether the base repository maintainers can modify the Pull Request. Default: false.
+     */
     maintainerCanModify?: pulumi.Input<boolean>;
+    /**
+     * The number of the Pull Request within the repository.
+     */
     number?: pulumi.Input<number>;
+    /**
+     * Unix timestamp indicating the Pull Request creation time.
+     */
     openedAt?: pulumi.Input<number>;
     /**
-     * Username of the PR creator
+     * GitHub login of the user who opened the Pull Request.
      */
     openedBy?: pulumi.Input<string>;
+    /**
+     * Owner of the repository. If not provided, the provider's default owner is used.
+     */
     owner?: pulumi.Input<string>;
+    /**
+     * the current Pull Request state - can be "open", "closed" or "merged".
+     */
     state?: pulumi.Input<string>;
+    /**
+     * The title of the Pull Request.
+     */
     title?: pulumi.Input<string>;
+    /**
+     * The timestamp of the last Pull Request update.
+     */
     updatedAt?: pulumi.Input<number>;
 }
 /**
  * The set of arguments for constructing a RepositoryPullRequest resource.
  */
 export interface RepositoryPullRequestArgs {
+    /**
+     * Name of the branch serving as the base of the Pull Request.
+     */
     baseRef: pulumi.Input<string>;
+    /**
+     * Name of the base repository to retrieve the Pull Requests from.
+     */
     baseRepository: pulumi.Input<string>;
+    /**
+     * Body of the Pull Request.
+     */
     body?: pulumi.Input<string>;
+    /**
+     * Name of the branch serving as the head of the Pull Request.
+     */
     headRef: pulumi.Input<string>;
+    /**
+     * Controls whether the base repository maintainers can modify the Pull Request. Default: false.
+     */
     maintainerCanModify?: pulumi.Input<boolean>;
+    /**
+     * Owner of the repository. If not provided, the provider's default owner is used.
+     */
     owner?: pulumi.Input<string>;
+    /**
+     * The title of the Pull Request.
+     */
     title: pulumi.Input<string>;
 }

package/repositoryPullRequest.js

@@ -5,7 +5,47 @@ Object.defineProperty(exports, "__esModule", { value: true });
 exports.RepositoryPullRequest = void 0;
 const pulumi = require("@pulumi/pulumi");
 const utilities = require("./utilities");
+/**
+ * This resource allows you to create and manage PullRequests for repositories within your GitHub organization or personal account.
+ *
+ * ## Example Usage
+ *
+ * ```typescript
+ * import * as pulumi from "@pulumi/pulumi";
+ * import * as github from "@pulumi/github";
+ *
+ * const example = new github.RepositoryPullRequest("example", {
+ *     baseRef: "main",
+ *     baseRepository: "example-repository",
+ *     body: "This will change everything",
+ *     headRef: "feature-branch",
+ *     title: "My newest feature",
+ * });
+ * ```
+ */
 class RepositoryPullRequest extends pulumi.CustomResource {
+    /**
+     * Get an existing RepositoryPullRequest resource's state with the given name, ID, and optional extra
+     * properties used to qualify the lookup.
+     *
+     * @param name The _unique_ name of the resulting resource.
+     * @param id The _unique_ provider ID of the resource to lookup.
+     * @param state Any extra arguments used during the lookup.
+     * @param opts Optional settings to control the behavior of the CustomResource.
+     */
+    static get(name, id, state, opts) {
+        return new RepositoryPullRequest(name, state, Object.assign(Object.assign({}, opts), { id: id }));
+    }
+    /**
+     * Returns true if the given object is an instance of RepositoryPullRequest.  This is designed to work even
+     * when multiple copies of the Pulumi SDK have been loaded into the same process.
+     */
+    static isInstance(obj) {
+        if (obj === undefined || obj === null) {
+            return false;
+        }
+        return obj['__pulumiType'] === RepositoryPullRequest.__pulumiType;
+    }
     constructor(name, argsOrState, opts) {
         let resourceInputs = {};
         opts = opts || {};
@@ -62,28 +102,6 @@ class RepositoryPullRequest extends pulumi.CustomResource {
         opts = pulumi.mergeOptions(utilities.resourceOptsDefaults(), opts);
         super(RepositoryPullRequest.__pulumiType, name, resourceInputs, opts);
     }
-    /**
-     * Get an existing RepositoryPullRequest resource's state with the given name, ID, and optional extra
-     * properties used to qualify the lookup.
-     *
-     * @param name The _unique_ name of the resulting resource.
-     * @param id The _unique_ provider ID of the resource to lookup.
-     * @param state Any extra arguments used during the lookup.
-     * @param opts Optional settings to control the behavior of the CustomResource.
-     */
-    static get(name, id, state, opts) {
-        return new RepositoryPullRequest(name, state, Object.assign(Object.assign({}, opts), { id: id }));
-    }
-    /**
-     * Returns true if the given object is an instance of RepositoryPullRequest.  This is designed to work even
-     * when multiple copies of the Pulumi SDK have been loaded into the same process.
-     */
-    static isInstance(obj) {
-        if (obj === undefined || obj === null) {
-            return false;
-        }
-        return obj['__pulumiType'] === RepositoryPullRequest.__pulumiType;
-    }
 }
 exports.RepositoryPullRequest = RepositoryPullRequest;
 /** @internal */