Organization
Creates a GitHub organization ruleset. 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
package generated_program;
import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.github.OrganizationRuleset;
import com.pulumi.github.OrganizationRulesetArgs;
import com.pulumi.github.inputs.OrganizationRulesetBypassActorArgs;
import com.pulumi.github.inputs.OrganizationRulesetConditionsArgs;
import com.pulumi.github.inputs.OrganizationRulesetConditionsRefNameArgs;
import com.pulumi.github.inputs.OrganizationRulesetRulesArgs;
import com.pulumi.github.inputs.OrganizationRulesetRulesBranchNamePatternArgs;
import java.util.List;
import java.util.ArrayList;
import java.util.Map;
import java.io.File;
import java.nio.file.Files;
import java.nio.file.Paths;
public class App {
public static void main(String[] args) {
Pulumi.run(App::stack);
}
public static void stack(Context ctx) {
var example = new OrganizationRuleset("example", OrganizationRulesetArgs.builder()
.bypassActors(OrganizationRulesetBypassActorArgs.builder()
.actorId(13473)
.actorType("Integration")
.bypassMode("always")
.build())
.conditions(OrganizationRulesetConditionsArgs.builder()
.refName(OrganizationRulesetConditionsRefNameArgs.builder()
.exclude()
.include("~ALL")
.build())
.build())
.enforcement("active")
.rules(OrganizationRulesetRulesArgs.builder()
.branchNamePattern(OrganizationRulesetRulesBranchNamePatternArgs.builder()
.name("example")
.negate(false)
.operator("starts_with")
.pattern("ex")
.build())
.creation(true)
.deletion(true)
.requiredLinearHistory(true)
.requiredSignatures(true)
.update(true)
.build())
.target("branch")
.build());
}
}Import
GitHub Organization Rulesets can be imported using the GitHub ruleset ID e.g.
$ pulumi import github:index/organizationRuleset:OrganizationRuleset example 12345`Constructors
Properties
(Block List) The actors that can bypass the rules in this ruleset. (see below for nested schema)
(Block List, Max: 1) Parameters for an organization ruleset condition. ref_name is required alongside one of repository_name or repository_id. (see below for nested schema)
(String) Possible values for Enforcement are disabled, active, evaluate. Note: evaluate is currently only supported for owners of type organization.
(Block List, Min: 1, Max: 1) Rules within the ruleset. (see below for nested schema)