@pulumi/github 5.1.0 → 5.2.0-alpha.1673638210

package/branch.d.ts

@@ -1,4 +1,42 @@
 import * as pulumi from "@pulumi/pulumi";
+/**
+ * This resource allows you to create and manage branches within your repository.
+ *
+ * Additional constraints can be applied to ensure your branch is created from
+ * another branch or commit.
+ *
+ * ## Example Usage
+ *
+ * ```typescript
+ * import * as pulumi from "@pulumi/pulumi";
+ * import * as github from "@pulumi/github";
+ *
+ * const development = new github.Branch("development", {
+ *     branch: "development",
+ *     repository: "example",
+ * });
+ * ```
+ *
+ * ## Import
+ *
+ * GitHub Branch can be imported using an ID made up of `repository:branch`, e.g.
+ *
+ * ```sh
+ *  $ pulumi import github:index/branch:Branch terraform terraform:main
+ * ```
+ *
+ *  Importing github branch into an instance object (when using a for each block to manage multiple branches)
+ *
+ * ```sh
+ *  $ pulumi import github:index/branch:Branch terraform["terraform"] terraform:main
+ * ```
+ *
+ *  Optionally, a source branch may be specified using an ID of `repository:branch:source_branch`. This is useful for importing branches that do not branch directly off main.
+ *
+ * ```sh
+ *  $ pulumi import github:index/branch:Branch terraform terraform:feature-branch:dev
+ * ```
+ */
 export declare class Branch extends pulumi.CustomResource {
     /**
      * Get an existing Branch resource's state with the given name, ID, and optional extra
@@ -15,12 +53,33 @@ export declare class Branch extends pulumi.CustomResource {
      * when multiple copies of the Pulumi SDK have been loaded into the same process.
      */
     static isInstance(obj: any): obj is Branch;
+    /**
+     * The repository branch to create.
+     */
     readonly branch: pulumi.Output<string>;
+    /**
+     * An etag representing the Branch object.
+     */
     readonly etag: pulumi.Output<string>;
+    /**
+     * A string representing a branch reference, in the form of `refs/heads/<branch>`.
+     */
     readonly ref: pulumi.Output<string>;
+    /**
+     * The GitHub repository name.
+     */
     readonly repository: pulumi.Output<string>;
+    /**
+     * A string storing the reference's `HEAD` commit's SHA1.
+     */
     readonly sha: pulumi.Output<string>;
+    /**
+     * The branch name to start from. Defaults to `main`.
+     */
     readonly sourceBranch: pulumi.Output<string | undefined>;
+    /**
+     * The commit hash to start from. Defaults to the tip of `sourceBranch`. If provided, `sourceBranch` is ignored.
+     */
     readonly sourceSha: pulumi.Output<string>;
     /**
      * Create a Branch resource with the given unique name, arguments, and options.
@@ -35,20 +94,53 @@ export declare class Branch extends pulumi.CustomResource {
  * Input properties used for looking up and filtering Branch resources.
  */
 export interface BranchState {
+    /**
+     * The repository branch to create.
+     */
     branch?: pulumi.Input<string>;
+    /**
+     * An etag representing the Branch object.
+     */
     etag?: pulumi.Input<string>;
+    /**
+     * A string representing a branch reference, in the form of `refs/heads/<branch>`.
+     */
     ref?: pulumi.Input<string>;
+    /**
+     * The GitHub repository name.
+     */
     repository?: pulumi.Input<string>;
+    /**
+     * A string storing the reference's `HEAD` commit's SHA1.
+     */
     sha?: pulumi.Input<string>;
+    /**
+     * The branch name to start from. Defaults to `main`.
+     */
     sourceBranch?: pulumi.Input<string>;
+    /**
+     * The commit hash to start from. Defaults to the tip of `sourceBranch`. If provided, `sourceBranch` is ignored.
+     */
     sourceSha?: pulumi.Input<string>;
 }
 /**
  * The set of arguments for constructing a Branch resource.
  */
 export interface BranchArgs {
+    /**
+     * The repository branch to create.
+     */
     branch: pulumi.Input<string>;
+    /**
+     * The GitHub repository name.
+     */
     repository: pulumi.Input<string>;
+    /**
+     * The branch name to start from. Defaults to `main`.
+     */
     sourceBranch?: pulumi.Input<string>;
+    /**
+     * The commit hash to start from. Defaults to the tip of `sourceBranch`. If provided, `sourceBranch` is ignored.
+     */
     sourceSha?: pulumi.Input<string>;
 }

package/branch.js

@@ -5,7 +5,67 @@ Object.defineProperty(exports, "__esModule", { value: true });
 exports.Branch = void 0;
 const pulumi = require("@pulumi/pulumi");
 const utilities = require("./utilities");
+/**
+ * This resource allows you to create and manage branches within your repository.
+ *
+ * Additional constraints can be applied to ensure your branch is created from
+ * another branch or commit.
+ *
+ * ## Example Usage
+ *
+ * ```typescript
+ * import * as pulumi from "@pulumi/pulumi";
+ * import * as github from "@pulumi/github";
+ *
+ * const development = new github.Branch("development", {
+ *     branch: "development",
+ *     repository: "example",
+ * });
+ * ```
+ *
+ * ## Import
+ *
+ * GitHub Branch can be imported using an ID made up of `repository:branch`, e.g.
+ *
+ * ```sh
+ *  $ pulumi import github:index/branch:Branch terraform terraform:main
+ * ```
+ *
+ *  Importing github branch into an instance object (when using a for each block to manage multiple branches)
+ *
+ * ```sh
+ *  $ pulumi import github:index/branch:Branch terraform["terraform"] terraform:main
+ * ```
+ *
+ *  Optionally, a source branch may be specified using an ID of `repository:branch:source_branch`. This is useful for importing branches that do not branch directly off main.
+ *
+ * ```sh
+ *  $ pulumi import github:index/branch:Branch terraform terraform:feature-branch:dev
+ * ```
+ */
 class Branch extends pulumi.CustomResource {
+    /**
+     * Get an existing Branch 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 Branch(name, state, Object.assign(Object.assign({}, opts), { id: id }));
+    }
+    /**
+     * Returns true if the given object is an instance of Branch.  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'] === Branch.__pulumiType;
+    }
     constructor(name, argsOrState, opts) {
         let resourceInputs = {};
         opts = opts || {};
@@ -38,28 +98,6 @@ class Branch extends pulumi.CustomResource {
         opts = pulumi.mergeOptions(utilities.resourceOptsDefaults(), opts);
         super(Branch.__pulumiType, name, resourceInputs, opts);
     }
-    /**
-     * Get an existing Branch 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 Branch(name, state, Object.assign(Object.assign({}, opts), { id: id }));
-    }
-    /**
-     * Returns true if the given object is an instance of Branch.  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'] === Branch.__pulumiType;
-    }
 }
 exports.Branch = Branch;
 /** @internal */

package/branch.js.map

@@ -1 +1 @@
-{"version":3,"file":"branch.js","sourceRoot":"","sources":["../branch.ts"],"names":[],"mappings":";AAAA,wFAAwF;AACxF,iFAAiF;;;AAEjF,yCAAyC;AACzC,yCAAyC;AAEzC,MAAa,MAAO,SAAQ,MAAM,CAAC,cAAc;IA4C7C,YAAY,IAAY,EAAE,WAAsC,EAAE,IAAmC;QACjG,IAAI,cAAc,GAAkB,EAAE,CAAC;QACvC,IAAI,GAAG,IAAI,IAAI,EAAE,CAAC;QAClB,IAAI,IAAI,CAAC,EAAE,EAAE;YACT,MAAM,KAAK,GAAG,WAAsC,CAAC;YACrD,cAAc,CAAC,QAAQ,CAAC,GAAG,KAAK,CAAC,CAAC,CAAC,KAAK,CAAC,MAAM,CAAC,CAAC,CAAC,SAAS,CAAC;YAC5D,cAAc,CAAC,MAAM,CAAC,GAAG,KAAK,CAAC,CAAC,CAAC,KAAK,CAAC,IAAI,CAAC,CAAC,CAAC,SAAS,CAAC;YACxD,cAAc,CAAC,KAAK,CAAC,GAAG,KAAK,CAAC,CAAC,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC,CAAC,SAAS,CAAC;YACtD,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;YACtD,cAAc,CAAC,cAAc,CAAC,GAAG,KAAK,CAAC,CAAC,CAAC,KAAK,CAAC,YAAY,CAAC,CAAC,CAAC,SAAS,CAAC;YACxE,cAAc,CAAC,WAAW,CAAC,GAAG,KAAK,CAAC,CAAC,CAAC,KAAK,CAAC,SAAS,CAAC,CAAC,CAAC,SAAS,CAAC;SACrE;aAAM;YACH,MAAM,IAAI,GAAG,WAAqC,CAAC;YACnD,IAAI,CAAC,CAAC,IAAI,IAAI,IAAI,CAAC,MAAM,KAAK,SAAS,CAAC,IAAI,CAAC,IAAI,CAAC,GAAG,EAAE;gBACnD,MAAM,IAAI,KAAK,CAAC,oCAAoC,CAAC,CAAC;aACzD;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,cAAc,CAAC,QAAQ,CAAC,GAAG,IAAI,CAAC,CAAC,CAAC,IAAI,CAAC,MAAM,CAAC,CAAC,CAAC,SAAS,CAAC;YAC1D,cAAc,CAAC,YAAY,CAAC,GAAG,IAAI,CAAC,CAAC,CAAC,IAAI,CAAC,UAAU,CAAC,CAAC,CAAC,SAAS,CAAC;YAClE,cAAc,CAAC,cAAc,CAAC,GAAG,IAAI,CAAC,CAAC,CAAC,IAAI,CAAC,YAAY,CAAC,CAAC,CAAC,SAAS,CAAC;YACtE,cAAc,CAAC,WAAW,CAAC,GAAG,IAAI,CAAC,CAAC,CAAC,IAAI,CAAC,SAAS,CAAC,CAAC,CAAC,SAAS,CAAC;YAChE,cAAc,CAAC,MAAM,CAAC,GAAG,SAAS,CAAC,OAAO,CAAC;YAC3C,cAAc,CAAC,KAAK,CAAC,GAAG,SAAS,CAAC,OAAO,CAAC;YAC1C,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,MAAM,CAAC,YAAY,EAAE,IAAI,EAAE,cAAc,EAAE,IAAI,CAAC,CAAC;IAC3D,CAAC;IAzED;;;;;;;;OAQG;IACI,MAAM,CAAC,GAAG,CAAC,IAAY,EAAE,EAA2B,EAAE,KAAmB,EAAE,IAAmC;QACjH,OAAO,IAAI,MAAM,CAAC,IAAI,EAAO,KAAK,kCAAO,IAAI,KAAE,EAAE,EAAE,EAAE,IAAG,CAAC;IAC7D,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,MAAM,CAAC,YAAY,CAAC;IACvD,CAAC;;AA1BL,wBA2EC;AA7DG,gBAAgB;AACO,mBAAY,GAAG,4BAA4B,CAAC"}
+{"version":3,"file":"branch.js","sourceRoot":"","sources":["../branch.ts"],"names":[],"mappings":";AAAA,wFAAwF;AACxF,iFAAiF;;;AAEjF,yCAAyC;AACzC,yCAAyC;AAEzC;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAqCG;AACH,MAAa,MAAO,SAAQ,MAAM,CAAC,cAAc;IAC7C;;;;;;;;OAQG;IACI,MAAM,CAAC,GAAG,CAAC,IAAY,EAAE,EAA2B,EAAE,KAAmB,EAAE,IAAmC;QACjH,OAAO,IAAI,MAAM,CAAC,IAAI,EAAO,KAAK,kCAAO,IAAI,KAAE,EAAE,EAAE,EAAE,IAAG,CAAC;IAC7D,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,MAAM,CAAC,YAAY,CAAC;IACvD,CAAC;IAuCD,YAAY,IAAY,EAAE,WAAsC,EAAE,IAAmC;QACjG,IAAI,cAAc,GAAkB,EAAE,CAAC;QACvC,IAAI,GAAG,IAAI,IAAI,EAAE,CAAC;QAClB,IAAI,IAAI,CAAC,EAAE,EAAE;YACT,MAAM,KAAK,GAAG,WAAsC,CAAC;YACrD,cAAc,CAAC,QAAQ,CAAC,GAAG,KAAK,CAAC,CAAC,CAAC,KAAK,CAAC,MAAM,CAAC,CAAC,CAAC,SAAS,CAAC;YAC5D,cAAc,CAAC,MAAM,CAAC,GAAG,KAAK,CAAC,CAAC,CAAC,KAAK,CAAC,IAAI,CAAC,CAAC,CAAC,SAAS,CAAC;YACxD,cAAc,CAAC,KAAK,CAAC,GAAG,KAAK,CAAC,CAAC,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC,CAAC,SAAS,CAAC;YACtD,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;YACtD,cAAc,CAAC,cAAc,CAAC,GAAG,KAAK,CAAC,CAAC,CAAC,KAAK,CAAC,YAAY,CAAC,CAAC,CAAC,SAAS,CAAC;YACxE,cAAc,CAAC,WAAW,CAAC,GAAG,KAAK,CAAC,CAAC,CAAC,KAAK,CAAC,SAAS,CAAC,CAAC,CAAC,SAAS,CAAC;SACrE;aAAM;YACH,MAAM,IAAI,GAAG,WAAqC,CAAC;YACnD,IAAI,CAAC,CAAC,IAAI,IAAI,IAAI,CAAC,MAAM,KAAK,SAAS,CAAC,IAAI,CAAC,IAAI,CAAC,GAAG,EAAE;gBACnD,MAAM,IAAI,KAAK,CAAC,oCAAoC,CAAC,CAAC;aACzD;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,cAAc,CAAC,QAAQ,CAAC,GAAG,IAAI,CAAC,CAAC,CAAC,IAAI,CAAC,MAAM,CAAC,CAAC,CAAC,SAAS,CAAC;YAC1D,cAAc,CAAC,YAAY,CAAC,GAAG,IAAI,CAAC,CAAC,CAAC,IAAI,CAAC,UAAU,CAAC,CAAC,CAAC,SAAS,CAAC;YAClE,cAAc,CAAC,cAAc,CAAC,GAAG,IAAI,CAAC,CAAC,CAAC,IAAI,CAAC,YAAY,CAAC,CAAC,CAAC,SAAS,CAAC;YACtE,cAAc,CAAC,WAAW,CAAC,GAAG,IAAI,CAAC,CAAC,CAAC,IAAI,CAAC,SAAS,CAAC,CAAC,CAAC,SAAS,CAAC;YAChE,cAAc,CAAC,MAAM,CAAC,GAAG,SAAS,CAAC,OAAO,CAAC;YAC3C,cAAc,CAAC,KAAK,CAAC,GAAG,SAAS,CAAC,OAAO,CAAC;YAC1C,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,MAAM,CAAC,YAAY,EAAE,IAAI,EAAE,cAAc,EAAE,IAAI,CAAC,CAAC;IAC3D,CAAC;;AA/FL,wBAgGC;AAlFG,gBAAgB;AACO,mBAAY,GAAG,4BAA4B,CAAC"}

package/branchDefault.d.ts

@@ -1,4 +1,39 @@
 import * as pulumi from "@pulumi/pulumi";
+/**
+ * Provides a GitHub branch default resource.
+ *
+ * This resource allows you to set the default branch for a given repository.
+ *
+ * Note that use of this resource is incompatible with the `defaultBranch` option of the `github.Repository` resource.  Using both will result in plans always showing a diff.
+ *
+ * ## 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",
+ *     autoInit: true,
+ * });
+ * const development = new github.Branch("development", {
+ *     repository: example.name,
+ *     branch: "development",
+ * });
+ * const _default = new github.BranchDefault("default", {
+ *     repository: example.name,
+ *     branch: development.branch,
+ * });
+ * ```
+ *
+ * ## Import
+ *
+ * GitHub Branch Defaults can be imported using an ID made up of `repository`, e.g.
+ *
+ * ```sh
+ *  $ pulumi import github:index/branchDefault:BranchDefault branch_default my-repo
+ * ```
+ */
 export declare class BranchDefault extends pulumi.CustomResource {
     /**
      * Get an existing BranchDefault resource's state with the given name, ID, and optional extra
@@ -15,7 +50,13 @@ export declare class BranchDefault extends pulumi.CustomResource {
      * when multiple copies of the Pulumi SDK have been loaded into the same process.
      */
     static isInstance(obj: any): obj is BranchDefault;
+    /**
+     * The branch (e.g. `main`)
+     */
     readonly branch: pulumi.Output<string>;
+    /**
+     * The GitHub repository
+     */
     readonly repository: pulumi.Output<string>;
     /**
      * Create a BranchDefault resource with the given unique name, arguments, and options.
@@ -30,13 +71,25 @@ export declare class BranchDefault extends pulumi.CustomResource {
  * Input properties used for looking up and filtering BranchDefault resources.
  */
 export interface BranchDefaultState {
+    /**
+     * The branch (e.g. `main`)
+     */
     branch?: pulumi.Input<string>;
+    /**
+     * The GitHub repository
+     */
     repository?: pulumi.Input<string>;
 }
 /**
  * The set of arguments for constructing a BranchDefault resource.
  */
 export interface BranchDefaultArgs {
+    /**
+     * The branch (e.g. `main`)
+     */
     branch: pulumi.Input<string>;
+    /**
+     * The GitHub repository
+     */
     repository: pulumi.Input<string>;
 }

package/branchDefault.js

@@ -5,29 +5,42 @@ Object.defineProperty(exports, "__esModule", { value: true });
 exports.BranchDefault = void 0;
 const pulumi = require("@pulumi/pulumi");
 const utilities = require("./utilities");
+/**
+ * Provides a GitHub branch default resource.
+ *
+ * This resource allows you to set the default branch for a given repository.
+ *
+ * Note that use of this resource is incompatible with the `defaultBranch` option of the `github.Repository` resource.  Using both will result in plans always showing a diff.
+ *
+ * ## 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",
+ *     autoInit: true,
+ * });
+ * const development = new github.Branch("development", {
+ *     repository: example.name,
+ *     branch: "development",
+ * });
+ * const _default = new github.BranchDefault("default", {
+ *     repository: example.name,
+ *     branch: development.branch,
+ * });
+ * ```
+ *
+ * ## Import
+ *
+ * GitHub Branch Defaults can be imported using an ID made up of `repository`, e.g.
+ *
+ * ```sh
+ *  $ pulumi import github:index/branchDefault:BranchDefault branch_default my-repo
+ * ```
+ */
 class BranchDefault extends pulumi.CustomResource {
-    constructor(name, argsOrState, opts) {
-        let resourceInputs = {};
-        opts = opts || {};
-        if (opts.id) {
-            const state = argsOrState;
-            resourceInputs["branch"] = state ? state.branch : undefined;
-            resourceInputs["repository"] = state ? state.repository : undefined;
-        }
-        else {
-            const args = argsOrState;
-            if ((!args || args.branch === undefined) && !opts.urn) {
-                throw new Error("Missing required property 'branch'");
-            }
-            if ((!args || args.repository === undefined) && !opts.urn) {
-                throw new Error("Missing required property 'repository'");
-            }
-            resourceInputs["branch"] = args ? args.branch : undefined;
-            resourceInputs["repository"] = args ? args.repository : undefined;
-        }
-        opts = pulumi.mergeOptions(utilities.resourceOptsDefaults(), opts);
-        super(BranchDefault.__pulumiType, name, resourceInputs, opts);
-    }
     /**
      * Get an existing BranchDefault resource's state with the given name, ID, and optional extra
      * properties used to qualify the lookup.
@@ -50,6 +63,28 @@ class BranchDefault extends pulumi.CustomResource {
         }
         return obj['__pulumiType'] === BranchDefault.__pulumiType;
     }
+    constructor(name, argsOrState, opts) {
+        let resourceInputs = {};
+        opts = opts || {};
+        if (opts.id) {
+            const state = argsOrState;
+            resourceInputs["branch"] = state ? state.branch : undefined;
+            resourceInputs["repository"] = state ? state.repository : undefined;
+        }
+        else {
+            const args = argsOrState;
+            if ((!args || args.branch === undefined) && !opts.urn) {
+                throw new Error("Missing required property 'branch'");
+            }
+            if ((!args || args.repository === undefined) && !opts.urn) {
+                throw new Error("Missing required property 'repository'");
+            }
+            resourceInputs["branch"] = args ? args.branch : undefined;
+            resourceInputs["repository"] = args ? args.repository : undefined;
+        }
+        opts = pulumi.mergeOptions(utilities.resourceOptsDefaults(), opts);
+        super(BranchDefault.__pulumiType, name, resourceInputs, opts);
+    }
 }
 exports.BranchDefault = BranchDefault;
 /** @internal */

package/branchDefault.js.map

@@ -1 +1 @@
-{"version":3,"file":"branchDefault.js","sourceRoot":"","sources":["../branchDefault.ts"],"names":[],"mappings":";AAAA,wFAAwF;AACxF,iFAAiF;;;AAEjF,yCAAyC;AACzC,yCAAyC;AAEzC,MAAa,aAAc,SAAQ,MAAM,CAAC,cAAc;IAuCpD,YAAY,IAAY,EAAE,WAAoD,EAAE,IAAmC;QAC/G,IAAI,cAAc,GAAkB,EAAE,CAAC;QACvC,IAAI,GAAG,IAAI,IAAI,EAAE,CAAC;QAClB,IAAI,IAAI,CAAC,EAAE,EAAE;YACT,MAAM,KAAK,GAAG,WAA6C,CAAC;YAC5D,cAAc,CAAC,QAAQ,CAAC,GAAG,KAAK,CAAC,CAAC,CAAC,KAAK,CAAC,MAAM,CAAC,CAAC,CAAC,SAAS,CAAC;YAC5D,cAAc,CAAC,YAAY,CAAC,GAAG,KAAK,CAAC,CAAC,CAAC,KAAK,CAAC,UAAU,CAAC,CAAC,CAAC,SAAS,CAAC;SACvE;aAAM;YACH,MAAM,IAAI,GAAG,WAA4C,CAAC;YAC1D,IAAI,CAAC,CAAC,IAAI,IAAI,IAAI,CAAC,MAAM,KAAK,SAAS,CAAC,IAAI,CAAC,IAAI,CAAC,GAAG,EAAE;gBACnD,MAAM,IAAI,KAAK,CAAC,oCAAoC,CAAC,CAAC;aACzD;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,cAAc,CAAC,QAAQ,CAAC,GAAG,IAAI,CAAC,CAAC,CAAC,IAAI,CAAC,MAAM,CAAC,CAAC,CAAC,SAAS,CAAC;YAC1D,cAAc,CAAC,YAAY,CAAC,GAAG,IAAI,CAAC,CAAC,CAAC,IAAI,CAAC,UAAU,CAAC,CAAC,CAAC,SAAS,CAAC;SACrE;QACD,IAAI,GAAG,MAAM,CAAC,YAAY,CAAC,SAAS,CAAC,oBAAoB,EAAE,EAAE,IAAI,CAAC,CAAC;QACnE,KAAK,CAAC,aAAa,CAAC,YAAY,EAAE,IAAI,EAAE,cAAc,EAAE,IAAI,CAAC,CAAC;IAClE,CAAC;IA1DD;;;;;;;;OAQG;IACI,MAAM,CAAC,GAAG,CAAC,IAAY,EAAE,EAA2B,EAAE,KAA0B,EAAE,IAAmC;QACxH,OAAO,IAAI,aAAa,CAAC,IAAI,EAAO,KAAK,kCAAO,IAAI,KAAE,EAAE,EAAE,EAAE,IAAG,CAAC;IACpE,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,aAAa,CAAC,YAAY,CAAC;IAC9D,CAAC;;AA1BL,sCA4DC;AA9CG,gBAAgB;AACO,0BAAY,GAAG,0CAA0C,CAAC"}
+{"version":3,"file":"branchDefault.js","sourceRoot":"","sources":["../branchDefault.ts"],"names":[],"mappings":";AAAA,wFAAwF;AACxF,iFAAiF;;;AAEjF,yCAAyC;AACzC,yCAAyC;AAEzC;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAkCG;AACH,MAAa,aAAc,SAAQ,MAAM,CAAC,cAAc;IACpD;;;;;;;;OAQG;IACI,MAAM,CAAC,GAAG,CAAC,IAAY,EAAE,EAA2B,EAAE,KAA0B,EAAE,IAAmC;QACxH,OAAO,IAAI,aAAa,CAAC,IAAI,EAAO,KAAK,kCAAO,IAAI,KAAE,EAAE,EAAE,EAAE,IAAG,CAAC;IACpE,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,aAAa,CAAC,YAAY,CAAC;IAC9D,CAAC;IAmBD,YAAY,IAAY,EAAE,WAAoD,EAAE,IAAmC;QAC/G,IAAI,cAAc,GAAkB,EAAE,CAAC;QACvC,IAAI,GAAG,IAAI,IAAI,EAAE,CAAC;QAClB,IAAI,IAAI,CAAC,EAAE,EAAE;YACT,MAAM,KAAK,GAAG,WAA6C,CAAC;YAC5D,cAAc,CAAC,QAAQ,CAAC,GAAG,KAAK,CAAC,CAAC,CAAC,KAAK,CAAC,MAAM,CAAC,CAAC,CAAC,SAAS,CAAC;YAC5D,cAAc,CAAC,YAAY,CAAC,GAAG,KAAK,CAAC,CAAC,CAAC,KAAK,CAAC,UAAU,CAAC,CAAC,CAAC,SAAS,CAAC;SACvE;aAAM;YACH,MAAM,IAAI,GAAG,WAA4C,CAAC;YAC1D,IAAI,CAAC,CAAC,IAAI,IAAI,IAAI,CAAC,MAAM,KAAK,SAAS,CAAC,IAAI,CAAC,IAAI,CAAC,GAAG,EAAE;gBACnD,MAAM,IAAI,KAAK,CAAC,oCAAoC,CAAC,CAAC;aACzD;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,cAAc,CAAC,QAAQ,CAAC,GAAG,IAAI,CAAC,CAAC,CAAC,IAAI,CAAC,MAAM,CAAC,CAAC,CAAC,SAAS,CAAC;YAC1D,cAAc,CAAC,YAAY,CAAC,GAAG,IAAI,CAAC,CAAC,CAAC,IAAI,CAAC,UAAU,CAAC,CAAC,CAAC,SAAS,CAAC;SACrE;QACD,IAAI,GAAG,MAAM,CAAC,YAAY,CAAC,SAAS,CAAC,oBAAoB,EAAE,EAAE,IAAI,CAAC,CAAC;QACnE,KAAK,CAAC,aAAa,CAAC,YAAY,EAAE,IAAI,EAAE,cAAc,EAAE,IAAI,CAAC,CAAC;IAClE,CAAC;;AAjEL,sCAkEC;AApDG,gBAAgB;AACO,0BAAY,GAAG,0CAA0C,CAAC"}

package/branchProtection.d.ts

@@ -1,6 +1,65 @@
 import * as pulumi from "@pulumi/pulumi";
 import * as inputs from "./types/input";
 import * as outputs from "./types/output";
+/**
+ * Protects a GitHub branch.
+ *
+ * This resource allows you to configure branch protection for repositories in your organization. When applied, the branch will be protected from forced pushes and deletion. Additional constraints, such as required status checks or restrictions on users, teams, and apps, can also be configured.
+ *
+ * ## Example Usage
+ *
+ * ```typescript
+ * import * as pulumi from "@pulumi/pulumi";
+ * import * as github from "@pulumi/github";
+ *
+ * const exampleRepository = new github.Repository("exampleRepository", {});
+ * const exampleUser = github.getUser({
+ *     username: "example",
+ * });
+ * const exampleTeam = new github.Team("exampleTeam", {});
+ * // Protect the main branch of the foo repository. Additionally, require that
+ * // the "ci/travis" context to be passing and only allow the engineers team merge
+ * // to the branch.
+ * const exampleBranchProtection = new github.BranchProtection("exampleBranchProtection", {
+ *     repositoryId: exampleRepository.nodeId,
+ *     pattern: "main",
+ *     enforceAdmins: true,
+ *     allowsDeletions: true,
+ *     requiredStatusChecks: [{
+ *         strict: false,
+ *         contexts: ["ci/travis"],
+ *     }],
+ *     requiredPullRequestReviews: [{
+ *         dismissStaleReviews: true,
+ *         restrictDismissals: true,
+ *         dismissalRestrictions: [
+ *             exampleUser.then(exampleUser => exampleUser.nodeId),
+ *             exampleTeam.nodeId,
+ *             "/exampleuser",
+ *             "exampleorganization/exampleteam",
+ *         ],
+ *     }],
+ *     pushRestrictions: [
+ *         exampleUser.then(exampleUser => exampleUser.nodeId),
+ *         "/exampleuser",
+ *         "exampleorganization/exampleteam",
+ *     ],
+ * });
+ * const exampleTeamRepository = new github.TeamRepository("exampleTeamRepository", {
+ *     teamId: exampleTeam.id,
+ *     repository: exampleRepository.name,
+ *     permission: "pull",
+ * });
+ * ```
+ *
+ * ## Import
+ *
+ * GitHub Branch Protection can be imported using an ID made up of `repository:pattern`, e.g.
+ *
+ * ```sh
+ *  $ pulumi import github:index/branchProtection:BranchProtection terraform terraform:main
+ * ```
+ */
 export declare class BranchProtection extends pulumi.CustomResource {
     /**
      * Get an existing BranchProtection resource's state with the given name, ID, and optional extra
@@ -17,20 +76,57 @@ export declare class BranchProtection extends pulumi.CustomResource {
      * when multiple copies of the Pulumi SDK have been loaded into the same process.
      */
     static isInstance(obj: any): obj is BranchProtection;
+    /**
+     * Boolean, setting this to `true` to allow the branch to be deleted.
+     */
     readonly allowsDeletions: pulumi.Output<boolean | undefined>;
+    /**
+     * Boolean, setting this to `true` to allow force pushes on the branch.
+     */
     readonly allowsForcePushes: pulumi.Output<boolean | undefined>;
+    /**
+     * Boolean, setting this to `true` to block creating the branch.
+     */
     readonly blocksCreations: pulumi.Output<boolean | undefined>;
+    /**
+     * Boolean, setting this to `true` enforces status checks for repository administrators.
+     */
     readonly enforceAdmins: pulumi.Output<boolean | undefined>;
+    /**
+     * Boolean, Setting this to `true` will make the branch read-only and preventing any pushes to it. Defaults to `false`
+     */
+    readonly lockBranch: pulumi.Output<boolean | undefined>;
+    /**
+     * Identifies the protection rule pattern.
+     */
     readonly pattern: pulumi.Output<string>;
+    /**
+     * The list of actor Names/IDs that may push to the branch. Actor names must either begin with a "/" for users or the organization name followed by a "/" for teams.
+     */
     readonly pushRestrictions: pulumi.Output<string[] | undefined>;
     /**
-     * Node ID or name of repository
+     * The name or node ID of the repository associated with this branch protection rule.
      */
     readonly repositoryId: pulumi.Output<string>;
+    /**
+     * Boolean, setting this to `true` requires all conversations on code must be resolved before a pull request can be merged.
+     */
     readonly requireConversationResolution: pulumi.Output<boolean | undefined>;
+    /**
+     * Boolean, setting this to `true` requires all commits to be signed with GPG.
+     */
     readonly requireSignedCommits: pulumi.Output<boolean | undefined>;
+    /**
+     * Boolean, setting this to `true` enforces a linear commit Git history, which prevents anyone from pushing merge commits to a branch
+     */
     readonly requiredLinearHistory: pulumi.Output<boolean | undefined>;
+    /**
+     * Enforce restrictions for pull request reviews. See Required Pull Request Reviews below for details.
+     */
     readonly requiredPullRequestReviews: pulumi.Output<outputs.BranchProtectionRequiredPullRequestReview[] | undefined>;
+    /**
+     * Enforce restrictions for required status checks. See Required Status Checks below for details.
+     */
     readonly requiredStatusChecks: pulumi.Output<outputs.BranchProtectionRequiredStatusCheck[] | undefined>;
     /**
      * Create a BranchProtection resource with the given unique name, arguments, and options.
@@ -45,39 +141,113 @@ export declare class BranchProtection extends pulumi.CustomResource {
  * Input properties used for looking up and filtering BranchProtection resources.
  */
 export interface BranchProtectionState {
+    /**
+     * Boolean, setting this to `true` to allow the branch to be deleted.
+     */
     allowsDeletions?: pulumi.Input<boolean>;
+    /**
+     * Boolean, setting this to `true` to allow force pushes on the branch.
+     */
     allowsForcePushes?: pulumi.Input<boolean>;
+    /**
+     * Boolean, setting this to `true` to block creating the branch.
+     */
     blocksCreations?: pulumi.Input<boolean>;
+    /**
+     * Boolean, setting this to `true` enforces status checks for repository administrators.
+     */
     enforceAdmins?: pulumi.Input<boolean>;
+    /**
+     * Boolean, Setting this to `true` will make the branch read-only and preventing any pushes to it. Defaults to `false`
+     */
+    lockBranch?: pulumi.Input<boolean>;
+    /**
+     * Identifies the protection rule pattern.
+     */
     pattern?: pulumi.Input<string>;
+    /**
+     * The list of actor Names/IDs that may push to the branch. Actor names must either begin with a "/" for users or the organization name followed by a "/" for teams.
+     */
     pushRestrictions?: pulumi.Input<pulumi.Input<string>[]>;
     /**
-     * Node ID or name of repository
+     * The name or node ID of the repository associated with this branch protection rule.
      */
     repositoryId?: pulumi.Input<string>;
+    /**
+     * Boolean, setting this to `true` requires all conversations on code must be resolved before a pull request can be merged.
+     */
     requireConversationResolution?: pulumi.Input<boolean>;
+    /**
+     * Boolean, setting this to `true` requires all commits to be signed with GPG.
+     */
     requireSignedCommits?: pulumi.Input<boolean>;
+    /**
+     * Boolean, setting this to `true` enforces a linear commit Git history, which prevents anyone from pushing merge commits to a branch
+     */
     requiredLinearHistory?: pulumi.Input<boolean>;
+    /**
+     * Enforce restrictions for pull request reviews. See Required Pull Request Reviews below for details.
+     */
     requiredPullRequestReviews?: pulumi.Input<pulumi.Input<inputs.BranchProtectionRequiredPullRequestReview>[]>;
+    /**
+     * Enforce restrictions for required status checks. See Required Status Checks below for details.
+     */
     requiredStatusChecks?: pulumi.Input<pulumi.Input<inputs.BranchProtectionRequiredStatusCheck>[]>;
 }
 /**
  * The set of arguments for constructing a BranchProtection resource.
  */
 export interface BranchProtectionArgs {
+    /**
+     * Boolean, setting this to `true` to allow the branch to be deleted.
+     */
     allowsDeletions?: pulumi.Input<boolean>;
+    /**
+     * Boolean, setting this to `true` to allow force pushes on the branch.
+     */
     allowsForcePushes?: pulumi.Input<boolean>;
+    /**
+     * Boolean, setting this to `true` to block creating the branch.
+     */
     blocksCreations?: pulumi.Input<boolean>;
+    /**
+     * Boolean, setting this to `true` enforces status checks for repository administrators.
+     */
     enforceAdmins?: pulumi.Input<boolean>;
+    /**
+     * Boolean, Setting this to `true` will make the branch read-only and preventing any pushes to it. Defaults to `false`
+     */
+    lockBranch?: pulumi.Input<boolean>;
+    /**
+     * Identifies the protection rule pattern.
+     */
     pattern: pulumi.Input<string>;
+    /**
+     * The list of actor Names/IDs that may push to the branch. Actor names must either begin with a "/" for users or the organization name followed by a "/" for teams.
+     */
     pushRestrictions?: pulumi.Input<pulumi.Input<string>[]>;
     /**
-     * Node ID or name of repository
+     * The name or node ID of the repository associated with this branch protection rule.
      */
     repositoryId: pulumi.Input<string>;
+    /**
+     * Boolean, setting this to `true` requires all conversations on code must be resolved before a pull request can be merged.
+     */
     requireConversationResolution?: pulumi.Input<boolean>;
+    /**
+     * Boolean, setting this to `true` requires all commits to be signed with GPG.
+     */
     requireSignedCommits?: pulumi.Input<boolean>;
+    /**
+     * Boolean, setting this to `true` enforces a linear commit Git history, which prevents anyone from pushing merge commits to a branch
+     */
     requiredLinearHistory?: pulumi.Input<boolean>;
+    /**
+     * Enforce restrictions for pull request reviews. See Required Pull Request Reviews below for details.
+     */
     requiredPullRequestReviews?: pulumi.Input<pulumi.Input<inputs.BranchProtectionRequiredPullRequestReview>[]>;
+    /**
+     * Enforce restrictions for required status checks. See Required Status Checks below for details.
+     */
     requiredStatusChecks?: pulumi.Input<pulumi.Input<inputs.BranchProtectionRequiredStatusCheck>[]>;
 }