OrganizationRuleset is the Schema for the OrganizationRulesets API. <no value>
Type
CRD
Group
enterprise.github.upbound.io
Version
v1alpha1
apiVersion: enterprise.github.upbound.io/v1alpha1
kind: OrganizationRuleset
OrganizationRulesetSpec defines the desired state of OrganizationRuleset
No description provided.
The actors that can bypass the rules in this ruleset.
Parameters for an organization ruleset condition. ref_name is required alongside one of repository_name or repository_id.
No description provided.
Array of ref names or patterns to exclude. The condition will not pass if any of these patterns match.
Array of ref names or patterns to include. One of these patterns must match for the condition to pass. Also accepts ~DEFAULT_BRANCH to include the default branch or ~ALL to include all branches.
The repository IDs that the ruleset applies to. One of these IDs must match for the condition to pass.
No description provided.
Array of repository names or patterns to exclude. The condition will not pass if any of these patterns match.
Array of repository names or patterns to include. One of these patterns must match for the condition to pass. Also accepts ~ALL to include all repositories.
Rules within the ruleset.
Parameters to be used for the branch_name_pattern rule. This rule only applies to repositories within an enterprise, it cannot be applied to repositories owned by individuals or regular organizations. Conflicts with tag_name_pattern as it only applies to rulesets with target branch.
Require all commits be made to a non-target branch and submitted via a pull request before they can be merged.
Choose which status checks must pass before branches can be merged into a branch that matches this rule. When enabled, commits must first be pushed to another branch, then merged or pushed directly to a branch that matches this rule after status checks have passed.
Status checks that are required. Several can be defined.
Choose which Actions workflows must pass before branches can be merged into a branch that matches this rule.
Actions workflows that are required. Several can be defined.
Parameters to be used for the tag_name_pattern rule. This rule only applies to repositories within an enterprise, it cannot be applied to repositories owned by individuals or regular organizations. Conflicts with branch_name_pattern as it only applies to rulesets with target tag.
THIS IS A BETA FIELD. It will be honored unless the Management Policies feature flag is disabled. InitProvider holds the same fields as ForProvider, with the exception of Identifier and other resource reference fields. The fields that are in InitProvider are merged into ForProvider when the resource is created. The same fields are also added to the terraform ignore_changes hook, to avoid updating them after creation. This is useful for fields that are required on creation, but we do not desire to update them after creation, for example because of an external controller is managing them, like an autoscaler.
The actors that can bypass the rules in this ruleset.
Parameters for an organization ruleset condition. ref_name is required alongside one of repository_name or repository_id.
No description provided.
Array of ref names or patterns to exclude. The condition will not pass if any of these patterns match.
Array of ref names or patterns to include. One of these patterns must match for the condition to pass. Also accepts ~DEFAULT_BRANCH to include the default branch or ~ALL to include all branches.
The repository IDs that the ruleset applies to. One of these IDs must match for the condition to pass.
No description provided.
Array of repository names or patterns to exclude. The condition will not pass if any of these patterns match.
Array of repository names or patterns to include. One of these patterns must match for the condition to pass. Also accepts ~ALL to include all repositories.
Rules within the ruleset.
Parameters to be used for the branch_name_pattern rule. This rule only applies to repositories within an enterprise, it cannot be applied to repositories owned by individuals or regular organizations. Conflicts with tag_name_pattern as it only applies to rulesets with target branch.
Require all commits be made to a non-target branch and submitted via a pull request before they can be merged.
Choose which status checks must pass before branches can be merged into a branch that matches this rule. When enabled, commits must first be pushed to another branch, then merged or pushed directly to a branch that matches this rule after status checks have passed.
Status checks that are required. Several can be defined.
Choose which Actions workflows must pass before branches can be merged into a branch that matches this rule.
Actions workflows that are required. Several can be defined.
Parameters to be used for the tag_name_pattern rule. This rule only applies to repositories within an enterprise, it cannot be applied to repositories owned by individuals or regular organizations. Conflicts with branch_name_pattern as it only applies to rulesets with target tag.
THIS IS A BETA FIELD. It is on by default but can be opted out through a Crossplane feature flag. ManagementPolicies specify the array of actions Crossplane is allowed to take on the managed and external resources. This field is planned to replace the DeletionPolicy field in a future release. Currently, both could be set independently and non-default values would be honored if the feature flag is enabled. If both are custom, the DeletionPolicy field will be ignored. See the design doc for more information: https://github.com/crossplane/crossplane/blob/499895a25d1a1a0ba1604944ef98ac7a1a71f197/design/design-doc-observe-only-resources.md?plain=1#L223 and this one: https://github.com/crossplane/crossplane/blob/444267e84783136daa93568b364a5f01228cacbe/design/one-pager-ignore-changes.md
ProviderConfigReference specifies how the provider that will be used to create, observe, update, and delete this managed resource should be configured.
Policies for referencing.
PublishConnectionDetailsTo specifies the connection secret config which contains a name, metadata and a reference to secret store config to which any connection details for this managed resource should be written. Connection details frequently include the endpoint, username, and password required to connect to the managed resource.
WriteConnectionSecretToReference specifies the namespace and name of a Secret to which any connection details for this managed resource should be written. Connection details frequently include the endpoint, username, and password required to connect to the managed resource. This field is planned to be replaced in a future release in favor of PublishConnectionDetailsTo. Currently, both could be set independently and connection details would be published to both without affecting each other.
OrganizationRulesetStatus defines the observed state of OrganizationRuleset.
No description provided.
The actors that can bypass the rules in this ruleset.
Parameters for an organization ruleset condition. ref_name is required alongside one of repository_name or repository_id.
No description provided.
Array of ref names or patterns to exclude. The condition will not pass if any of these patterns match.
Array of ref names or patterns to include. One of these patterns must match for the condition to pass. Also accepts ~DEFAULT_BRANCH to include the default branch or ~ALL to include all branches.
The repository IDs that the ruleset applies to. One of these IDs must match for the condition to pass.
No description provided.
Array of repository names or patterns to exclude. The condition will not pass if any of these patterns match.
Array of repository names or patterns to include. One of these patterns must match for the condition to pass. Also accepts ~ALL to include all repositories.
Rules within the ruleset.
Parameters to be used for the branch_name_pattern rule. This rule only applies to repositories within an enterprise, it cannot be applied to repositories owned by individuals or regular organizations. Conflicts with tag_name_pattern as it only applies to rulesets with target branch.
Require all commits be made to a non-target branch and submitted via a pull request before they can be merged.
Choose which status checks must pass before branches can be merged into a branch that matches this rule. When enabled, commits must first be pushed to another branch, then merged or pushed directly to a branch that matches this rule after status checks have passed.
Status checks that are required. Several can be defined.
Choose which Actions workflows must pass before branches can be merged into a branch that matches this rule.
Actions workflows that are required. Several can be defined.
Parameters to be used for the tag_name_pattern rule. This rule only applies to repositories within an enterprise, it cannot be applied to repositories owned by individuals or regular organizations. Conflicts with branch_name_pattern as it only applies to rulesets with target tag.
Conditions of the resource.
example
apiVersion: enterprise.github.upbound.io/v1alpha1
kind: OrganizationRuleset
metadata:
name: example
spec:
forProvider:
bypassActors:
- actorId: 13473
actorType: Integration
bypassMode: always
conditions:
refName:
exclude: []
include:
- ~ALL
enforcement: disabled
name: example
rules:
- branchNamePattern:
- name: example
negate: false
operator: starts_with
pattern: ex
creation: true
deletion: true
requiredLinearHistory: true
requiredSignatures: true
update: true
target: branch
providerConfigRef:
name: github-provider
© 2022 Upbound, Inc.
Discover the building blocksfor your internal cloud platform.