@pulumi/github 6.0.0-alpha.1709363818 → 6.0.0-alpha.1768023817

package/organizationRoleTeamAssignment.d.ts

@@ -0,0 +1,94 @@
+import * as pulumi from "@pulumi/pulumi";
+/**
+ * > **Note:** This resource is deprecated, please use the `github.OrganizationRoleTeam` resource instead.
+ *
+ * This resource manages relationships between teams and organization roles
+ * in your GitHub organization. This works on predefined roles, and custom roles, where the latter is an Enterprise feature.
+ *
+ * Creating this resource assigns the role to a team.
+ *
+ * The organization role and team must both belong to the same organization
+ * on GitHub.
+ *
+ * ## Example Usage
+ *
+ * ```typescript
+ * import * as pulumi from "@pulumi/pulumi";
+ * import * as github from "@pulumi/github";
+ *
+ * const test_team = new github.Team("test-team", {name: "test-team"});
+ * const test_team_role_assignment = new github.OrganizationRoleTeamAssignment("test-team-role-assignment", {
+ *     teamSlug: test_team.slug,
+ *     roleId: "8132",
+ * });
+ * ```
+ *
+ * ## Import
+ *
+ * GitHub Team Organization Role Assignment can be imported using an ID made up of `team_slug:role_id`
+ *
+ * text
+ *
+ * ```sh
+ * $ pulumi import github:index/organizationRoleTeamAssignment:OrganizationRoleTeamAssignment role_assignment test-team:8132
+ * ```
+ */
+export declare class OrganizationRoleTeamAssignment extends pulumi.CustomResource {
+    /**
+     * Get an existing OrganizationRoleTeamAssignment 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: string, id: pulumi.Input<pulumi.ID>, state?: OrganizationRoleTeamAssignmentState, opts?: pulumi.CustomResourceOptions): OrganizationRoleTeamAssignment;
+    /**
+     * Returns true if the given object is an instance of OrganizationRoleTeamAssignment.  This is designed to work even
+     * when multiple copies of the Pulumi SDK have been loaded into the same process.
+     */
+    static isInstance(obj: any): obj is OrganizationRoleTeamAssignment;
+    /**
+     * The GitHub organization role id
+     */
+    readonly roleId: pulumi.Output<string>;
+    /**
+     * The GitHub team slug
+     */
+    readonly teamSlug: pulumi.Output<string>;
+    /**
+     * Create a OrganizationRoleTeamAssignment resource with the given unique name, arguments, and options.
+     *
+     * @param name The _unique_ name of the resource.
+     * @param args The arguments to use to populate this resource's properties.
+     * @param opts A bag of options that control this resource's behavior.
+     */
+    constructor(name: string, args: OrganizationRoleTeamAssignmentArgs, opts?: pulumi.CustomResourceOptions);
+}
+/**
+ * Input properties used for looking up and filtering OrganizationRoleTeamAssignment resources.
+ */
+export interface OrganizationRoleTeamAssignmentState {
+    /**
+     * The GitHub organization role id
+     */
+    roleId?: pulumi.Input<string>;
+    /**
+     * The GitHub team slug
+     */
+    teamSlug?: pulumi.Input<string>;
+}
+/**
+ * The set of arguments for constructing a OrganizationRoleTeamAssignment resource.
+ */
+export interface OrganizationRoleTeamAssignmentArgs {
+    /**
+     * The GitHub organization role id
+     */
+    roleId: pulumi.Input<string>;
+    /**
+     * The GitHub team slug
+     */
+    teamSlug: pulumi.Input<string>;
+}

package/organizationRoleTeamAssignment.js

@@ -0,0 +1,91 @@
+"use strict";
+// *** WARNING: this file was generated by pulumi-language-nodejs. ***
+// *** Do not edit by hand unless you're certain you know what you are doing! ***
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.OrganizationRoleTeamAssignment = void 0;
+const pulumi = require("@pulumi/pulumi");
+const utilities = require("./utilities");
+/**
+ * > **Note:** This resource is deprecated, please use the `github.OrganizationRoleTeam` resource instead.
+ *
+ * This resource manages relationships between teams and organization roles
+ * in your GitHub organization. This works on predefined roles, and custom roles, where the latter is an Enterprise feature.
+ *
+ * Creating this resource assigns the role to a team.
+ *
+ * The organization role and team must both belong to the same organization
+ * on GitHub.
+ *
+ * ## Example Usage
+ *
+ * ```typescript
+ * import * as pulumi from "@pulumi/pulumi";
+ * import * as github from "@pulumi/github";
+ *
+ * const test_team = new github.Team("test-team", {name: "test-team"});
+ * const test_team_role_assignment = new github.OrganizationRoleTeamAssignment("test-team-role-assignment", {
+ *     teamSlug: test_team.slug,
+ *     roleId: "8132",
+ * });
+ * ```
+ *
+ * ## Import
+ *
+ * GitHub Team Organization Role Assignment can be imported using an ID made up of `team_slug:role_id`
+ *
+ * text
+ *
+ * ```sh
+ * $ pulumi import github:index/organizationRoleTeamAssignment:OrganizationRoleTeamAssignment role_assignment test-team:8132
+ * ```
+ */
+class OrganizationRoleTeamAssignment extends pulumi.CustomResource {
+    /**
+     * Get an existing OrganizationRoleTeamAssignment 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 OrganizationRoleTeamAssignment(name, state, { ...opts, id: id });
+    }
+    /**
+     * Returns true if the given object is an instance of OrganizationRoleTeamAssignment.  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'] === OrganizationRoleTeamAssignment.__pulumiType;
+    }
+    constructor(name, argsOrState, opts) {
+        let resourceInputs = {};
+        opts = opts || {};
+        if (opts.id) {
+            const state = argsOrState;
+            resourceInputs["roleId"] = state?.roleId;
+            resourceInputs["teamSlug"] = state?.teamSlug;
+        }
+        else {
+            const args = argsOrState;
+            if (args?.roleId === undefined && !opts.urn) {
+                throw new Error("Missing required property 'roleId'");
+            }
+            if (args?.teamSlug === undefined && !opts.urn) {
+                throw new Error("Missing required property 'teamSlug'");
+            }
+            resourceInputs["roleId"] = args?.roleId;
+            resourceInputs["teamSlug"] = args?.teamSlug;
+        }
+        opts = pulumi.mergeOptions(utilities.resourceOptsDefaults(), opts);
+        super(OrganizationRoleTeamAssignment.__pulumiType, name, resourceInputs, opts);
+    }
+}
+exports.OrganizationRoleTeamAssignment = OrganizationRoleTeamAssignment;
+/** @internal */
+OrganizationRoleTeamAssignment.__pulumiType = 'github:index/organizationRoleTeamAssignment:OrganizationRoleTeamAssignment';
+//# sourceMappingURL=organizationRoleTeamAssignment.js.map

package/organizationRoleTeamAssignment.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"organizationRoleTeamAssignment.js","sourceRoot":"","sources":["../organizationRoleTeamAssignment.ts"],"names":[],"mappings":";AAAA,sEAAsE;AACtE,iFAAiF;;;AAEjF,yCAAyC;AACzC,yCAAyC;AAEzC;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAiCG;AACH,MAAa,8BAA+B,SAAQ,MAAM,CAAC,cAAc;IACrE;;;;;;;;OAQG;IACI,MAAM,CAAC,GAAG,CAAC,IAAY,EAAE,EAA2B,EAAE,KAA2C,EAAE,IAAmC;QACzI,OAAO,IAAI,8BAA8B,CAAC,IAAI,EAAO,KAAK,EAAE,EAAE,GAAG,IAAI,EAAE,EAAE,EAAE,EAAE,EAAE,CAAC,CAAC;IACrF,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,8BAA8B,CAAC,YAAY,CAAC;IAC/E,CAAC;IAmBD,YAAY,IAAY,EAAE,WAAsF,EAAE,IAAmC;QACjJ,IAAI,cAAc,GAAkB,EAAE,CAAC;QACvC,IAAI,GAAG,IAAI,IAAI,EAAE,CAAC;QAClB,IAAI,IAAI,CAAC,EAAE,EAAE;YACT,MAAM,KAAK,GAAG,WAA8D,CAAC;YAC7E,cAAc,CAAC,QAAQ,CAAC,GAAG,KAAK,EAAE,MAAM,CAAC;YACzC,cAAc,CAAC,UAAU,CAAC,GAAG,KAAK,EAAE,QAAQ,CAAC;SAChD;aAAM;YACH,MAAM,IAAI,GAAG,WAA6D,CAAC;YAC3E,IAAI,IAAI,EAAE,MAAM,KAAK,SAAS,IAAI,CAAC,IAAI,CAAC,GAAG,EAAE;gBACzC,MAAM,IAAI,KAAK,CAAC,oCAAoC,CAAC,CAAC;aACzD;YACD,IAAI,IAAI,EAAE,QAAQ,KAAK,SAAS,IAAI,CAAC,IAAI,CAAC,GAAG,EAAE;gBAC3C,MAAM,IAAI,KAAK,CAAC,sCAAsC,CAAC,CAAC;aAC3D;YACD,cAAc,CAAC,QAAQ,CAAC,GAAG,IAAI,EAAE,MAAM,CAAC;YACxC,cAAc,CAAC,UAAU,CAAC,GAAG,IAAI,EAAE,QAAQ,CAAC;SAC/C;QACD,IAAI,GAAG,MAAM,CAAC,YAAY,CAAC,SAAS,CAAC,oBAAoB,EAAE,EAAE,IAAI,CAAC,CAAC;QACnE,KAAK,CAAC,8BAA8B,CAAC,YAAY,EAAE,IAAI,EAAE,cAAc,EAAE,IAAI,CAAC,CAAC;IACnF,CAAC;;AAjEL,wEAkEC;AApDG,gBAAgB;AACO,2CAAY,GAAG,4EAA4E,CAAC"}

package/organizationRoleUser.d.ts

@@ -0,0 +1,83 @@
+import * as pulumi from "@pulumi/pulumi";
+/**
+ * Manage an association between an organization role and a user.
+ *
+ * ## Example Usage
+ *
+ * ```typescript
+ * import * as pulumi from "@pulumi/pulumi";
+ * import * as github from "@pulumi/github";
+ *
+ * const example = new github.OrganizationRoleUser("example", {
+ *     roleId: 1234,
+ *     login: "example-user",
+ * });
+ * ```
+ *
+ * ## Import
+ *
+ * An organization role user association can be imported using the role ID and the user login separated by a `:`.
+ *
+ * ```sh
+ * $ pulumi import github:index/organizationRoleUser:OrganizationRoleUser example "1234:example-user"
+ * ```
+ */
+export declare class OrganizationRoleUser extends pulumi.CustomResource {
+    /**
+     * Get an existing OrganizationRoleUser 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: string, id: pulumi.Input<pulumi.ID>, state?: OrganizationRoleUserState, opts?: pulumi.CustomResourceOptions): OrganizationRoleUser;
+    /**
+     * Returns true if the given object is an instance of OrganizationRoleUser.  This is designed to work even
+     * when multiple copies of the Pulumi SDK have been loaded into the same process.
+     */
+    static isInstance(obj: any): obj is OrganizationRoleUser;
+    /**
+     * The login for the GitHub user account.
+     */
+    readonly login: pulumi.Output<string>;
+    /**
+     * The ID of the organization role.
+     */
+    readonly roleId: pulumi.Output<number>;
+    /**
+     * Create a OrganizationRoleUser resource with the given unique name, arguments, and options.
+     *
+     * @param name The _unique_ name of the resource.
+     * @param args The arguments to use to populate this resource's properties.
+     * @param opts A bag of options that control this resource's behavior.
+     */
+    constructor(name: string, args: OrganizationRoleUserArgs, opts?: pulumi.CustomResourceOptions);
+}
+/**
+ * Input properties used for looking up and filtering OrganizationRoleUser resources.
+ */
+export interface OrganizationRoleUserState {
+    /**
+     * The login for the GitHub user account.
+     */
+    login?: pulumi.Input<string>;
+    /**
+     * The ID of the organization role.
+     */
+    roleId?: pulumi.Input<number>;
+}
+/**
+ * The set of arguments for constructing a OrganizationRoleUser resource.
+ */
+export interface OrganizationRoleUserArgs {
+    /**
+     * The login for the GitHub user account.
+     */
+    login: pulumi.Input<string>;
+    /**
+     * The ID of the organization role.
+     */
+    roleId: pulumi.Input<number>;
+}

package/organizationRoleUser.js

@@ -0,0 +1,80 @@
+"use strict";
+// *** WARNING: this file was generated by pulumi-language-nodejs. ***
+// *** Do not edit by hand unless you're certain you know what you are doing! ***
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.OrganizationRoleUser = void 0;
+const pulumi = require("@pulumi/pulumi");
+const utilities = require("./utilities");
+/**
+ * Manage an association between an organization role and a user.
+ *
+ * ## Example Usage
+ *
+ * ```typescript
+ * import * as pulumi from "@pulumi/pulumi";
+ * import * as github from "@pulumi/github";
+ *
+ * const example = new github.OrganizationRoleUser("example", {
+ *     roleId: 1234,
+ *     login: "example-user",
+ * });
+ * ```
+ *
+ * ## Import
+ *
+ * An organization role user association can be imported using the role ID and the user login separated by a `:`.
+ *
+ * ```sh
+ * $ pulumi import github:index/organizationRoleUser:OrganizationRoleUser example "1234:example-user"
+ * ```
+ */
+class OrganizationRoleUser extends pulumi.CustomResource {
+    /**
+     * Get an existing OrganizationRoleUser 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 OrganizationRoleUser(name, state, { ...opts, id: id });
+    }
+    /**
+     * Returns true if the given object is an instance of OrganizationRoleUser.  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'] === OrganizationRoleUser.__pulumiType;
+    }
+    constructor(name, argsOrState, opts) {
+        let resourceInputs = {};
+        opts = opts || {};
+        if (opts.id) {
+            const state = argsOrState;
+            resourceInputs["login"] = state?.login;
+            resourceInputs["roleId"] = state?.roleId;
+        }
+        else {
+            const args = argsOrState;
+            if (args?.login === undefined && !opts.urn) {
+                throw new Error("Missing required property 'login'");
+            }
+            if (args?.roleId === undefined && !opts.urn) {
+                throw new Error("Missing required property 'roleId'");
+            }
+            resourceInputs["login"] = args?.login;
+            resourceInputs["roleId"] = args?.roleId;
+        }
+        opts = pulumi.mergeOptions(utilities.resourceOptsDefaults(), opts);
+        super(OrganizationRoleUser.__pulumiType, name, resourceInputs, opts);
+    }
+}
+exports.OrganizationRoleUser = OrganizationRoleUser;
+/** @internal */
+OrganizationRoleUser.__pulumiType = 'github:index/organizationRoleUser:OrganizationRoleUser';
+//# sourceMappingURL=organizationRoleUser.js.map

package/organizationRoleUser.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"organizationRoleUser.js","sourceRoot":"","sources":["../organizationRoleUser.ts"],"names":[],"mappings":";AAAA,sEAAsE;AACtE,iFAAiF;;;AAEjF,yCAAyC;AACzC,yCAAyC;AAEzC;;;;;;;;;;;;;;;;;;;;;;GAsBG;AACH,MAAa,oBAAqB,SAAQ,MAAM,CAAC,cAAc;IAC3D;;;;;;;;OAQG;IACI,MAAM,CAAC,GAAG,CAAC,IAAY,EAAE,EAA2B,EAAE,KAAiC,EAAE,IAAmC;QAC/H,OAAO,IAAI,oBAAoB,CAAC,IAAI,EAAO,KAAK,EAAE,EAAE,GAAG,IAAI,EAAE,EAAE,EAAE,EAAE,EAAE,CAAC,CAAC;IAC3E,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,oBAAoB,CAAC,YAAY,CAAC;IACrE,CAAC;IAmBD,YAAY,IAAY,EAAE,WAAkE,EAAE,IAAmC;QAC7H,IAAI,cAAc,GAAkB,EAAE,CAAC;QACvC,IAAI,GAAG,IAAI,IAAI,EAAE,CAAC;QAClB,IAAI,IAAI,CAAC,EAAE,EAAE;YACT,MAAM,KAAK,GAAG,WAAoD,CAAC;YACnE,cAAc,CAAC,OAAO,CAAC,GAAG,KAAK,EAAE,KAAK,CAAC;YACvC,cAAc,CAAC,QAAQ,CAAC,GAAG,KAAK,EAAE,MAAM,CAAC;SAC5C;aAAM;YACH,MAAM,IAAI,GAAG,WAAmD,CAAC;YACjE,IAAI,IAAI,EAAE,KAAK,KAAK,SAAS,IAAI,CAAC,IAAI,CAAC,GAAG,EAAE;gBACxC,MAAM,IAAI,KAAK,CAAC,mCAAmC,CAAC,CAAC;aACxD;YACD,IAAI,IAAI,EAAE,MAAM,KAAK,SAAS,IAAI,CAAC,IAAI,CAAC,GAAG,EAAE;gBACzC,MAAM,IAAI,KAAK,CAAC,oCAAoC,CAAC,CAAC;aACzD;YACD,cAAc,CAAC,OAAO,CAAC,GAAG,IAAI,EAAE,KAAK,CAAC;YACtC,cAAc,CAAC,QAAQ,CAAC,GAAG,IAAI,EAAE,MAAM,CAAC;SAC3C;QACD,IAAI,GAAG,MAAM,CAAC,YAAY,CAAC,SAAS,CAAC,oBAAoB,EAAE,EAAE,IAAI,CAAC,CAAC;QACnE,KAAK,CAAC,oBAAoB,CAAC,YAAY,EAAE,IAAI,EAAE,cAAc,EAAE,IAAI,CAAC,CAAC;IACzE,CAAC;;AAjEL,oDAkEC;AApDG,gBAAgB;AACO,iCAAY,GAAG,wDAAwD,CAAC"}

package/organizationRuleset.d.ts

@@ -6,6 +6,95 @@ import * as outputs from "./types/output";
  *
  * This resource allows you to create and manage rulesets on the organization level. When applied, a new ruleset will be created. When destroyed, that ruleset will be removed.
  *
+ * ## Example Usage
+ *
+ * ```typescript
+ * import * as pulumi from "@pulumi/pulumi";
+ * import * as github from "@pulumi/github";
+ *
+ * const example = new github.OrganizationRuleset("example", {
+ *     name: "example",
+ *     target: "branch",
+ *     enforcement: "active",
+ *     conditions: {
+ *         refName: {
+ *             includes: ["~ALL"],
+ *             excludes: [],
+ *         },
+ *     },
+ *     bypassActors: [{
+ *         actorId: 13473,
+ *         actorType: "Integration",
+ *         bypassMode: "always",
+ *     }],
+ *     rules: {
+ *         creation: true,
+ *         update: true,
+ *         deletion: true,
+ *         requiredLinearHistory: true,
+ *         requiredSignatures: true,
+ *         branchNamePattern: {
+ *             name: "example",
+ *             negate: false,
+ *             operator: "starts_with",
+ *             pattern: "ex",
+ *         },
+ *         requiredWorkflows: {
+ *             doNotEnforceOnCreate: true,
+ *             requiredWorkflows: [{
+ *                 repositoryId: 1234,
+ *                 path: ".github/workflows/ci.yml",
+ *                 ref: "main",
+ *             }],
+ *         },
+ *         requiredCodeScanning: {
+ *             requiredCodeScanningTools: [{
+ *                 alertsThreshold: "errors",
+ *                 securityAlertsThreshold: "high_or_higher",
+ *                 tool: "CodeQL",
+ *             }],
+ *         },
+ *     },
+ * });
+ * // Example with push ruleset
+ * const examplePush = new github.OrganizationRuleset("example_push", {
+ *     name: "example_push",
+ *     target: "push",
+ *     enforcement: "active",
+ *     conditions: {
+ *         refName: {
+ *             includes: ["~ALL"],
+ *             excludes: [],
+ *         },
+ *         repositoryName: {
+ *             includes: ["~ALL"],
+ *             excludes: [],
+ *         },
+ *     },
+ *     rules: {
+ *         filePathRestriction: {
+ *             restrictedFilePaths: [
+ *                 ".github/workflows/*",
+ *                 "*.env",
+ *             ],
+ *         },
+ *         maxFileSize: {
+ *             maxFileSize: 100,
+ *         },
+ *         maxFilePathLength: {
+ *             maxFilePathLength: 255,
+ *         },
+ *         fileExtensionRestriction: {
+ *             restrictedFileExtensions: [
+ *                 "*.exe",
+ *                 "*.dll",
+ *                 "*.so",
+ *             ],
+ *         },
+ *     },
+ * });
+ * ```
+ *
  * ## Import
  *
  * GitHub Organization Rulesets can be imported using the GitHub ruleset ID e.g.
@@ -63,7 +152,7 @@ export declare class OrganizationRuleset extends pulumi.CustomResource {
      */
     readonly rulesetId: pulumi.Output<number>;
     /**
-     * (String) Possible values are `branch` and `tag`.
+     * (String) Possible values are `branch`, `tag` and `push`.
      */
     readonly target: pulumi.Output<string>;
     /**
@@ -112,7 +201,7 @@ export interface OrganizationRulesetState {
      */
     rulesetId?: pulumi.Input<number>;
     /**
-     * (String) Possible values are `branch` and `tag`.
+     * (String) Possible values are `branch`, `tag` and `push`.
      */
     target?: pulumi.Input<string>;
 }
@@ -141,7 +230,7 @@ export interface OrganizationRulesetArgs {
      */
     rules: pulumi.Input<inputs.OrganizationRulesetRules>;
     /**
-     * (String) Possible values are `branch` and `tag`.
+     * (String) Possible values are `branch`, `tag` and `push`.
      */
     target: pulumi.Input<string>;
 }

package/organizationRuleset.js

@@ -1,5 +1,5 @@
 "use strict";
-// *** WARNING: this file was generated by the Pulumi Terraform Bridge (tfgen) Tool. ***
+// *** WARNING: this file was generated by pulumi-language-nodejs. ***
 // *** Do not edit by hand unless you're certain you know what you are doing! ***
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.OrganizationRuleset = void 0;
@@ -10,6 +10,95 @@ const utilities = require("./utilities");
  *
  * This resource allows you to create and manage rulesets on the organization level. When applied, a new ruleset will be created. When destroyed, that ruleset will be removed.
  *
+ * ## Example Usage
+ *
+ * ```typescript
+ * import * as pulumi from "@pulumi/pulumi";
+ * import * as github from "@pulumi/github";
+ *
+ * const example = new github.OrganizationRuleset("example", {
+ *     name: "example",
+ *     target: "branch",
+ *     enforcement: "active",
+ *     conditions: {
+ *         refName: {
+ *             includes: ["~ALL"],
+ *             excludes: [],
+ *         },
+ *     },
+ *     bypassActors: [{
+ *         actorId: 13473,
+ *         actorType: "Integration",
+ *         bypassMode: "always",
+ *     }],
+ *     rules: {
+ *         creation: true,
+ *         update: true,
+ *         deletion: true,
+ *         requiredLinearHistory: true,
+ *         requiredSignatures: true,
+ *         branchNamePattern: {
+ *             name: "example",
+ *             negate: false,
+ *             operator: "starts_with",
+ *             pattern: "ex",
+ *         },
+ *         requiredWorkflows: {
+ *             doNotEnforceOnCreate: true,
+ *             requiredWorkflows: [{
+ *                 repositoryId: 1234,
+ *                 path: ".github/workflows/ci.yml",
+ *                 ref: "main",
+ *             }],
+ *         },
+ *         requiredCodeScanning: {
+ *             requiredCodeScanningTools: [{
+ *                 alertsThreshold: "errors",
+ *                 securityAlertsThreshold: "high_or_higher",
+ *                 tool: "CodeQL",
+ *             }],
+ *         },
+ *     },
+ * });
+ * // Example with push ruleset
+ * const examplePush = new github.OrganizationRuleset("example_push", {
+ *     name: "example_push",
+ *     target: "push",
+ *     enforcement: "active",
+ *     conditions: {
+ *         refName: {
+ *             includes: ["~ALL"],
+ *             excludes: [],
+ *         },
+ *         repositoryName: {
+ *             includes: ["~ALL"],
+ *             excludes: [],
+ *         },
+ *     },
+ *     rules: {
+ *         filePathRestriction: {
+ *             restrictedFilePaths: [
+ *                 ".github/workflows/*",
+ *                 "*.env",
+ *             ],
+ *         },
+ *         maxFileSize: {
+ *             maxFileSize: 100,
+ *         },
+ *         maxFilePathLength: {
+ *             maxFilePathLength: 255,
+ *         },
+ *         fileExtensionRestriction: {
+ *             restrictedFileExtensions: [
+ *                 "*.exe",
+ *                 "*.dll",
+ *                 "*.so",
+ *             ],
+ *         },
+ *     },
+ * });
+ * ```
+ *
  * ## Import
  *
  * GitHub Organization Rulesets can be imported using the GitHub ruleset ID e.g.
@@ -29,7 +118,7 @@ class OrganizationRuleset extends pulumi.CustomResource {
      * @param opts Optional settings to control the behavior of the CustomResource.
      */
     static get(name, id, state, opts) {
-        return new OrganizationRuleset(name, state, Object.assign(Object.assign({}, opts), { id: id }));
+        return new OrganizationRuleset(name, state, { ...opts, id: id });
     }
     /**
      * Returns true if the given object is an instance of OrganizationRuleset.  This is designed to work even
@@ -46,33 +135,33 @@ class OrganizationRuleset extends pulumi.CustomResource {
         opts = opts || {};
         if (opts.id) {
             const state = argsOrState;
-            resourceInputs["bypassActors"] = state ? state.bypassActors : undefined;
-            resourceInputs["conditions"] = state ? state.conditions : undefined;
-            resourceInputs["enforcement"] = state ? state.enforcement : undefined;
-            resourceInputs["etag"] = state ? state.etag : undefined;
-            resourceInputs["name"] = state ? state.name : undefined;
-            resourceInputs["nodeId"] = state ? state.nodeId : undefined;
-            resourceInputs["rules"] = state ? state.rules : undefined;
-            resourceInputs["rulesetId"] = state ? state.rulesetId : undefined;
-            resourceInputs["target"] = state ? state.target : undefined;
+            resourceInputs["bypassActors"] = state?.bypassActors;
+            resourceInputs["conditions"] = state?.conditions;
+            resourceInputs["enforcement"] = state?.enforcement;
+            resourceInputs["etag"] = state?.etag;
+            resourceInputs["name"] = state?.name;
+            resourceInputs["nodeId"] = state?.nodeId;
+            resourceInputs["rules"] = state?.rules;
+            resourceInputs["rulesetId"] = state?.rulesetId;
+            resourceInputs["target"] = state?.target;
         }
         else {
             const args = argsOrState;
-            if ((!args || args.enforcement === undefined) && !opts.urn) {
+            if (args?.enforcement === undefined && !opts.urn) {
                 throw new Error("Missing required property 'enforcement'");
             }
-            if ((!args || args.rules === undefined) && !opts.urn) {
+            if (args?.rules === undefined && !opts.urn) {
                 throw new Error("Missing required property 'rules'");
             }
-            if ((!args || args.target === undefined) && !opts.urn) {
+            if (args?.target === undefined && !opts.urn) {
                 throw new Error("Missing required property 'target'");
             }
-            resourceInputs["bypassActors"] = args ? args.bypassActors : undefined;
-            resourceInputs["conditions"] = args ? args.conditions : undefined;
-            resourceInputs["enforcement"] = args ? args.enforcement : undefined;
-            resourceInputs["name"] = args ? args.name : undefined;
-            resourceInputs["rules"] = args ? args.rules : undefined;
-            resourceInputs["target"] = args ? args.target : undefined;
+            resourceInputs["bypassActors"] = args?.bypassActors;
+            resourceInputs["conditions"] = args?.conditions;
+            resourceInputs["enforcement"] = args?.enforcement;
+            resourceInputs["name"] = args?.name;
+            resourceInputs["rules"] = args?.rules;
+            resourceInputs["target"] = args?.target;
             resourceInputs["etag"] = undefined /*out*/;
             resourceInputs["nodeId"] = undefined /*out*/;
             resourceInputs["rulesetId"] = undefined /*out*/;

package/organizationRuleset.js.map

@@ -1 +1 @@
-{"version":3,"file":"organizationRuleset.js","sourceRoot":"","sources":["../organizationRuleset.ts"],"names":[],"mappings":";AAAA,wFAAwF;AACxF,iFAAiF;;;AAEjF,yCAAyC;AAGzC,yCAAyC;AAEzC;;;;;;;;;;;;GAYG;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;IA+CD,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,cAAc,CAAC,GAAG,KAAK,CAAC,CAAC,CAAC,KAAK,CAAC,YAAY,CAAC,CAAC,CAAC,SAAS,CAAC;YACxE,cAAc,CAAC,YAAY,CAAC,GAAG,KAAK,CAAC,CAAC,CAAC,KAAK,CAAC,UAAU,CAAC,CAAC,CAAC,SAAS,CAAC;YACpE,cAAc,CAAC,aAAa,CAAC,GAAG,KAAK,CAAC,CAAC,CAAC,KAAK,CAAC,WAAW,CAAC,CAAC,CAAC,SAAS,CAAC;YACtE,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,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,WAAW,CAAC,GAAG,KAAK,CAAC,CAAC,CAAC,KAAK,CAAC,SAAS,CAAC,CAAC,CAAC,SAAS,CAAC;YAClE,cAAc,CAAC,QAAQ,CAAC,GAAG,KAAK,CAAC,CAAC,CAAC,KAAK,CAAC,MAAM,CAAC,CAAC,CAAC,SAAS,CAAC;SAC/D;aAAM;YACH,MAAM,IAAI,GAAG,WAAkD,CAAC;YAChE,IAAI,CAAC,CAAC,IAAI,IAAI,IAAI,CAAC,WAAW,KAAK,SAAS,CAAC,IAAI,CAAC,IAAI,CAAC,GAAG,EAAE;gBACxD,MAAM,IAAI,KAAK,CAAC,yCAAyC,CAAC,CAAC;aAC9D;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,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,cAAc,CAAC,cAAc,CAAC,GAAG,IAAI,CAAC,CAAC,CAAC,IAAI,CAAC,YAAY,CAAC,CAAC,CAAC,SAAS,CAAC;YACtE,cAAc,CAAC,YAAY,CAAC,GAAG,IAAI,CAAC,CAAC,CAAC,IAAI,CAAC,UAAU,CAAC,CAAC,CAAC,SAAS,CAAC;YAClE,cAAc,CAAC,aAAa,CAAC,GAAG,IAAI,CAAC,CAAC,CAAC,IAAI,CAAC,WAAW,CAAC,CAAC,CAAC,SAAS,CAAC;YACpE,cAAc,CAAC,MAAM,CAAC,GAAG,IAAI,CAAC,CAAC,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC,CAAC,SAAS,CAAC;YACtD,cAAc,CAAC,OAAO,CAAC,GAAG,IAAI,CAAC,CAAC,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC,CAAC,SAAS,CAAC;YACxD,cAAc,CAAC,QAAQ,CAAC,GAAG,IAAI,CAAC,CAAC,CAAC,IAAI,CAAC,MAAM,CAAC,CAAC,CAAC,SAAS,CAAC;YAC1D,cAAc,CAAC,MAAM,CAAC,GAAG,SAAS,CAAC,OAAO,CAAC;YAC3C,cAAc,CAAC,QAAQ,CAAC,GAAG,SAAS,CAAC,OAAO,CAAC;YAC7C,cAAc,CAAC,WAAW,CAAC,GAAG,SAAS,CAAC,OAAO,CAAC;SACnD;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;;AA9GL,kDA+GC;AAjGG,gBAAgB;AACO,gCAAY,GAAG,sDAAsD,CAAC"}
+{"version":3,"file":"organizationRuleset.js","sourceRoot":"","sources":["../organizationRuleset.ts"],"names":[],"mappings":";AAAA,sEAAsE;AACtE,iFAAiF;;;AAEjF,yCAAyC;AAGzC,yCAAyC;AAEzC;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAqGG;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,EAAE,EAAE,GAAG,IAAI,EAAE,EAAE,EAAE,EAAE,EAAE,CAAC,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;IA+CD,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,cAAc,CAAC,GAAG,KAAK,EAAE,YAAY,CAAC;YACrD,cAAc,CAAC,YAAY,CAAC,GAAG,KAAK,EAAE,UAAU,CAAC;YACjD,cAAc,CAAC,aAAa,CAAC,GAAG,KAAK,EAAE,WAAW,CAAC;YACnD,cAAc,CAAC,MAAM,CAAC,GAAG,KAAK,EAAE,IAAI,CAAC;YACrC,cAAc,CAAC,MAAM,CAAC,GAAG,KAAK,EAAE,IAAI,CAAC;YACrC,cAAc,CAAC,QAAQ,CAAC,GAAG,KAAK,EAAE,MAAM,CAAC;YACzC,cAAc,CAAC,OAAO,CAAC,GAAG,KAAK,EAAE,KAAK,CAAC;YACvC,cAAc,CAAC,WAAW,CAAC,GAAG,KAAK,EAAE,SAAS,CAAC;YAC/C,cAAc,CAAC,QAAQ,CAAC,GAAG,KAAK,EAAE,MAAM,CAAC;SAC5C;aAAM;YACH,MAAM,IAAI,GAAG,WAAkD,CAAC;YAChE,IAAI,IAAI,EAAE,WAAW,KAAK,SAAS,IAAI,CAAC,IAAI,CAAC,GAAG,EAAE;gBAC9C,MAAM,IAAI,KAAK,CAAC,yCAAyC,CAAC,CAAC;aAC9D;YACD,IAAI,IAAI,EAAE,KAAK,KAAK,SAAS,IAAI,CAAC,IAAI,CAAC,GAAG,EAAE;gBACxC,MAAM,IAAI,KAAK,CAAC,mCAAmC,CAAC,CAAC;aACxD;YACD,IAAI,IAAI,EAAE,MAAM,KAAK,SAAS,IAAI,CAAC,IAAI,CAAC,GAAG,EAAE;gBACzC,MAAM,IAAI,KAAK,CAAC,oCAAoC,CAAC,CAAC;aACzD;YACD,cAAc,CAAC,cAAc,CAAC,GAAG,IAAI,EAAE,YAAY,CAAC;YACpD,cAAc,CAAC,YAAY,CAAC,GAAG,IAAI,EAAE,UAAU,CAAC;YAChD,cAAc,CAAC,aAAa,CAAC,GAAG,IAAI,EAAE,WAAW,CAAC;YAClD,cAAc,CAAC,MAAM,CAAC,GAAG,IAAI,EAAE,IAAI,CAAC;YACpC,cAAc,CAAC,OAAO,CAAC,GAAG,IAAI,EAAE,KAAK,CAAC;YACtC,cAAc,CAAC,QAAQ,CAAC,GAAG,IAAI,EAAE,MAAM,CAAC;YACxC,cAAc,CAAC,MAAM,CAAC,GAAG,SAAS,CAAC,OAAO,CAAC;YAC3C,cAAc,CAAC,QAAQ,CAAC,GAAG,SAAS,CAAC,OAAO,CAAC;YAC7C,cAAc,CAAC,WAAW,CAAC,GAAG,SAAS,CAAC,OAAO,CAAC;SACnD;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;;AA9GL,kDA+GC;AAjGG,gBAAgB;AACO,gCAAY,GAAG,sDAAsD,CAAC"}