repo.v1alpha1.repositoryRuleset

"RepositoryRuleset is the Schema for the RepositoryRulesets API. Creates a GitHub repository ruleset."

Index

fn new(name)
obj metadata
obj spec

Fields

fn new

new(name)

new returns an instance of RepositoryRuleset

obj metadata

"ObjectMeta is metadata that all persisted resources must have, which includes all objects users must create."

fn metadata.withAnnotations

withAnnotations(annotations)

"Annotations is an unstructured key value map stored with a resource that may be set by external tools to store and retrieve arbitrary metadata. They are not queryable and should be preserved when modifying objects. More info: http://kubernetes.io/docs/user-guide/annotations"

fn metadata.withAnnotationsMixin

withAnnotationsMixin(annotations)

"Annotations is an unstructured key value map stored with a resource that may be set by external tools to store and retrieve arbitrary metadata. They are not queryable and should be preserved when modifying objects. More info: http://kubernetes.io/docs/user-guide/annotations"

Note: This function appends passed data to existing values

fn metadata.withClusterName

withClusterName(clusterName)

"The name of the cluster which the object belongs to. This is used to distinguish resources with same name and namespace in different clusters. This field is not set anywhere right now and apiserver is going to ignore it if set in create or update request."

fn metadata.withCreationTimestamp

withCreationTimestamp(creationTimestamp)

"Time is a wrapper around time.Time which supports correct marshaling to YAML and JSON. Wrappers are provided for many of the factory methods that the time package offers."

fn metadata.withDeletionGracePeriodSeconds

withDeletionGracePeriodSeconds(deletionGracePeriodSeconds)

"Number of seconds allowed for this object to gracefully terminate before it will be removed from the system. Only set when deletionTimestamp is also set. May only be shortened. Read-only."

fn metadata.withDeletionTimestamp

withDeletionTimestamp(deletionTimestamp)

"Time is a wrapper around time.Time which supports correct marshaling to YAML and JSON. Wrappers are provided for many of the factory methods that the time package offers."

fn metadata.withFinalizers

withFinalizers(finalizers)

"Must be empty before the object is deleted from the registry. Each entry is an identifier for the responsible component that will remove the entry from the list. If the deletionTimestamp of the object is non-nil, entries in this list can only be removed. Finalizers may be processed and removed in any order. Order is NOT enforced because it introduces significant risk of stuck finalizers. finalizers is a shared field, any actor with permission can reorder it. If the finalizer list is processed in order, then this can lead to a situation in which the component responsible for the first finalizer in the list is waiting for a signal (field value, external system, or other) produced by a component responsible for a finalizer later in the list, resulting in a deadlock. Without enforced ordering finalizers are free to order amongst themselves and are not vulnerable to ordering changes in the list."

fn metadata.withFinalizersMixin

withFinalizersMixin(finalizers)

"Must be empty before the object is deleted from the registry. Each entry is an identifier for the responsible component that will remove the entry from the list. If the deletionTimestamp of the object is non-nil, entries in this list can only be removed. Finalizers may be processed and removed in any order. Order is NOT enforced because it introduces significant risk of stuck finalizers. finalizers is a shared field, any actor with permission can reorder it. If the finalizer list is processed in order, then this can lead to a situation in which the component responsible for the first finalizer in the list is waiting for a signal (field value, external system, or other) produced by a component responsible for a finalizer later in the list, resulting in a deadlock. Without enforced ordering finalizers are free to order amongst themselves and are not vulnerable to ordering changes in the list."

Note: This function appends passed data to existing values

fn metadata.withGenerateName

withGenerateName(generateName)

"GenerateName is an optional prefix, used by the server, to generate a unique name ONLY IF the Name field has not been provided. If this field is used, the name returned to the client will be different than the name passed. This value will also be combined with a unique suffix. The provided value has the same validation rules as the Name field, and may be truncated by the length of the suffix required to make the value unique on the server.\n\nIf this field is specified and the generated name exists, the server will NOT return a 409 - instead, it will either return 201 Created or 500 with Reason ServerTimeout indicating a unique name could not be found in the time allotted, and the client should retry (optionally after the time indicated in the Retry-After header).\n\nApplied only if Name is not specified. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#idempotency"

fn metadata.withGeneration

withGeneration(generation)

"A sequence number representing a specific generation of the desired state. Populated by the system. Read-only."

fn metadata.withLabels

withLabels(labels)

"Map of string keys and values that can be used to organize and categorize (scope and select) objects. May match selectors of replication controllers and services. More info: http://kubernetes.io/docs/user-guide/labels"

fn metadata.withLabelsMixin

withLabelsMixin(labels)

"Map of string keys and values that can be used to organize and categorize (scope and select) objects. May match selectors of replication controllers and services. More info: http://kubernetes.io/docs/user-guide/labels"

Note: This function appends passed data to existing values

fn metadata.withName

withName(name)

"Name must be unique within a namespace. Is required when creating resources, although some resources may allow a client to request the generation of an appropriate name automatically. Name is primarily intended for creation idempotence and configuration definition. Cannot be updated. More info: http://kubernetes.io/docs/user-guide/identifiers#names"

fn metadata.withNamespace

withNamespace(namespace)

"Namespace defines the space within which each name must be unique. An empty namespace is equivalent to the \"default\" namespace, but \"default\" is the canonical representation. Not all objects are required to be scoped to a namespace - the value of this field for those objects will be empty.\n\nMust be a DNS_LABEL. Cannot be updated. More info: http://kubernetes.io/docs/user-guide/namespaces"

fn metadata.withOwnerReferences

withOwnerReferences(ownerReferences)

"List of objects depended by this object. If ALL objects in the list have been deleted, this object will be garbage collected. If this object is managed by a controller, then an entry in this list will point to this controller, with the controller field set to true. There cannot be more than one managing controller."

fn metadata.withOwnerReferencesMixin

withOwnerReferencesMixin(ownerReferences)

"List of objects depended by this object. If ALL objects in the list have been deleted, this object will be garbage collected. If this object is managed by a controller, then an entry in this list will point to this controller, with the controller field set to true. There cannot be more than one managing controller."

Note: This function appends passed data to existing values

fn metadata.withResourceVersion

withResourceVersion(resourceVersion)

"An opaque value that represents the internal version of this object that can be used by clients to determine when objects have changed. May be used for optimistic concurrency, change detection, and the watch operation on a resource or set of resources. Clients must treat these values as opaque and passed unmodified back to the server. They may only be valid for a particular resource or set of resources.\n\nPopulated by the system. Read-only. Value must be treated as opaque by clients and . More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#concurrency-control-and-consistency"

fn metadata.withSelfLink

withSelfLink(selfLink)

"SelfLink is a URL representing this object. Populated by the system. Read-only.\n\nDEPRECATED Kubernetes will stop propagating this field in 1.20 release and the field is planned to be removed in 1.21 release."

fn metadata.withUid

withUid(uid)

"UID is the unique in time and space value for this object. It is typically generated by the server on successful creation of a resource and is not allowed to change on PUT operations.\n\nPopulated by the system. Read-only. More info: http://kubernetes.io/docs/user-guide/identifiers#uids"

obj spec

"RepositoryRulesetSpec defines the desired state of RepositoryRuleset"

fn spec.withManagementPolicies

withManagementPolicies(managementPolicies)

"THIS IS A BETA FIELD. It is on by default but can be opted out\nthrough a Crossplane feature flag.\nManagementPolicies specify the array of actions Crossplane is allowed to\ntake on the managed and external resources.\nSee the design doc for more information: https://github.com/crossplane/crossplane/blob/499895a25d1a1a0ba1604944ef98ac7a1a71f197/design/design-doc-observe-only-resources.md?plain=1#L223\nand this one: https://github.com/crossplane/crossplane/blob/444267e84783136daa93568b364a5f01228cacbe/design/one-pager-ignore-changes.md"

fn spec.withManagementPoliciesMixin

withManagementPoliciesMixin(managementPolicies)

"THIS IS A BETA FIELD. It is on by default but can be opted out\nthrough a Crossplane feature flag.\nManagementPolicies specify the array of actions Crossplane is allowed to\ntake on the managed and external resources.\nSee the design doc for more information: https://github.com/crossplane/crossplane/blob/499895a25d1a1a0ba1604944ef98ac7a1a71f197/design/design-doc-observe-only-resources.md?plain=1#L223\nand this one: https://github.com/crossplane/crossplane/blob/444267e84783136daa93568b364a5f01228cacbe/design/one-pager-ignore-changes.md"

Note: This function appends passed data to existing values

obj spec.forProvider

fn spec.forProvider.withBypassActors

withBypassActors(bypassActors)

"(Block List) The actors that can bypass the rules in this ruleset. (see below for nested schema)\nThe actors that can bypass the rules in this ruleset."

fn spec.forProvider.withBypassActorsMixin

withBypassActorsMixin(bypassActors)

"(Block List) The actors that can bypass the rules in this ruleset. (see below for nested schema)\nThe actors that can bypass the rules in this ruleset."

Note: This function appends passed data to existing values

fn spec.forProvider.withConditions

withConditions(conditions)

"(Block List, Max: 1) Parameters for a repository ruleset ref name condition. (see below for nested schema)\nParameters for a repository ruleset ref name condition."

fn spec.forProvider.withConditionsMixin

withConditionsMixin(conditions)

"(Block List, Max: 1) Parameters for a repository ruleset ref name condition. (see below for nested schema)\nParameters for a repository ruleset ref name condition."

Note: This function appends passed data to existing values

fn spec.forProvider.withEnforcement

withEnforcement(enforcement)

"(String) Possible values for Enforcement are disabled, active, evaluate. Note: evaluate is currently only supported for owners of type organization.\nPossible values for Enforcement are disabled, active, evaluate. Note: evaluate is currently only supported for owners of type organization."

fn spec.forProvider.withName

withName(name)

"(String) The name of the ruleset.\nThe name of the ruleset."

fn spec.forProvider.withRepository

withRepository(repository)

"(String) Name of the repository to apply rulset to.\nName of the repository to apply rulset to."

fn spec.forProvider.withRules

withRules(rules)

"(Block List, Min: 1, Max: 1) Rules within the ruleset. (see below for nested schema)\nRules within the ruleset."

fn spec.forProvider.withRulesMixin

withRulesMixin(rules)

"(Block List, Min: 1, Max: 1) Rules within the ruleset. (see below for nested schema)\nRules within the ruleset."

Note: This function appends passed data to existing values

fn spec.forProvider.withTarget

withTarget(target)

"(String) Possible values are branch and tag.\nPossible values are branch and tag."

obj spec.forProvider.bypassActors

"(Block List) The actors that can bypass the rules in this ruleset. (see below for nested schema)\nThe actors that can bypass the rules in this ruleset."

fn spec.forProvider.bypassActors.withActorId

withActorId(actorId)

"(Number) The ID of the actor that can bypass a ruleset. If actor_type is Integration, actor_id is a GitHub App ID. App ID can be obtained by following instructions from the Get an App API docs\nThe ID of the actor that can bypass a ruleset. When actor_type is OrganizationAdmin, this should be set to 1."

fn spec.forProvider.bypassActors.withActorType

withActorType(actorType)

"(String) The type of actor that can bypass a ruleset. Can be one of: RepositoryRole, Team, Integration, OrganizationAdmin.\nThe type of actor that can bypass a ruleset. Can be one of: RepositoryRole, Team, Integration, OrganizationAdmin."

fn spec.forProvider.bypassActors.withBypassMode

withBypassMode(bypassMode)

"(String) When the specified actor can bypass the ruleset. pull_request means that an actor can only bypass rules on pull requests. Can be one of: always, pull_request.\nWhen the specified actor can bypass the ruleset. pull_request means that an actor can only bypass rules on pull requests. Can be one of: always, pull_request."

obj spec.forProvider.conditions

"(Block List, Max: 1) Parameters for a repository ruleset ref name condition. (see below for nested schema)\nParameters for a repository ruleset ref name condition."

fn spec.forProvider.conditions.withRefName

withRefName(refName)

"(Block List, Min: 1, Max: 1) (see below for nested schema)"

fn spec.forProvider.conditions.withRefNameMixin

withRefNameMixin(refName)

"(Block List, Min: 1, Max: 1) (see below for nested schema)"

Note: This function appends passed data to existing values

obj spec.forProvider.conditions.refName

"(Block List, Min: 1, Max: 1) (see below for nested schema)"

fn spec.forProvider.conditions.refName.withExclude

withExclude(exclude)

"(List of String) Array of ref names or patterns to exclude. The condition will not pass if any of these patterns match.\nArray of ref names or patterns to exclude. The condition will not pass if any of these patterns match."

fn spec.forProvider.conditions.refName.withExcludeMixin

withExcludeMixin(exclude)

"(List of String) Array of ref names or patterns to exclude. The condition will not pass if any of these patterns match.\nArray of ref names or patterns to exclude. The condition will not pass if any of these patterns match."

Note: This function appends passed data to existing values

fn spec.forProvider.conditions.refName.withInclude

withInclude(include)

"(List of String) 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.\nArray 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."

fn spec.forProvider.conditions.refName.withIncludeMixin

withIncludeMixin(include)

"(List of String) 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.\nArray 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."

Note: This function appends passed data to existing values

obj spec.forProvider.repositoryRef

"Reference to a Repository in repo to populate repository."

fn spec.forProvider.repositoryRef.withName

withName(name)

"Name of the referenced object."

fn spec.forProvider.repositoryRef.withNamespace

withNamespace(namespace)

"Namespace of the referenced object"

obj spec.forProvider.repositoryRef.policy

"Policies for referencing."

fn spec.forProvider.repositoryRef.policy.withResolution

withResolution(resolution)

"Resolution specifies whether resolution of this reference is required.\nThe default is 'Required', which means the reconcile will fail if the\nreference cannot be resolved. 'Optional' means this reference will be\na no-op if it cannot be resolved."

fn spec.forProvider.repositoryRef.policy.withResolve

withResolve(resolve)

"Resolve specifies when this reference should be resolved. The default\nis 'IfNotPresent', which will attempt to resolve the reference only when\nthe corresponding field is not present. Use 'Always' to resolve the\nreference on every reconcile."

obj spec.forProvider.repositorySelector

"Selector for a Repository in repo to populate repository."

fn spec.forProvider.repositorySelector.withMatchControllerRef

withMatchControllerRef(matchControllerRef)

"MatchControllerRef ensures an object with the same controller reference\nas the selecting object is selected."

fn spec.forProvider.repositorySelector.withMatchLabels

withMatchLabels(matchLabels)

"MatchLabels ensures an object with matching labels is selected."

fn spec.forProvider.repositorySelector.withMatchLabelsMixin

withMatchLabelsMixin(matchLabels)

"MatchLabels ensures an object with matching labels is selected."

Note: This function appends passed data to existing values

fn spec.forProvider.repositorySelector.withNamespace

withNamespace(namespace)

"Namespace for the selector"

obj spec.forProvider.repositorySelector.policy

"Policies for selection."

fn spec.forProvider.repositorySelector.policy.withResolution

withResolution(resolution)

"Resolution specifies whether resolution of this reference is required.\nThe default is 'Required', which means the reconcile will fail if the\nreference cannot be resolved. 'Optional' means this reference will be\na no-op if it cannot be resolved."

fn spec.forProvider.repositorySelector.policy.withResolve

withResolve(resolve)

"Resolve specifies when this reference should be resolved. The default\nis 'IfNotPresent', which will attempt to resolve the reference only when\nthe corresponding field is not present. Use 'Always' to resolve the\nreference on every reconcile."

obj spec.forProvider.rules

"(Block List, Min: 1, Max: 1) Rules within the ruleset. (see below for nested schema)\nRules within the ruleset."

fn spec.forProvider.rules.withBranchNamePattern

withBranchNamePattern(branchNamePattern)

"(Block List, Max: 1) 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 applied to rulesets with target branch. (see below for nested schema)\nParameters 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."

fn spec.forProvider.rules.withBranchNamePatternMixin

withBranchNamePatternMixin(branchNamePattern)

"(Block List, Max: 1) 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 applied to rulesets with target branch. (see below for nested schema)\nParameters 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."

Note: This function appends passed data to existing values

fn spec.forProvider.rules.withCommitAuthorEmailPattern

withCommitAuthorEmailPattern(commitAuthorEmailPattern)

"(Block List, Max: 1) Parameters to be used for the commit_author_email_pattern rule. This rule only applies to repositories within an enterprise, it cannot be applied to repositories owned by individuals or regular organizations. (see below for nested schema)\nParameters to be used for the commit_author_email_pattern rule. This rule only applies to repositories within an enterprise, it cannot be applied to repositories owned by individuals or regular organizations."

fn spec.forProvider.rules.withCommitAuthorEmailPatternMixin

withCommitAuthorEmailPatternMixin(commitAuthorEmailPattern)

"(Block List, Max: 1) Parameters to be used for the commit_author_email_pattern rule. This rule only applies to repositories within an enterprise, it cannot be applied to repositories owned by individuals or regular organizations. (see below for nested schema)\nParameters to be used for the commit_author_email_pattern rule. This rule only applies to repositories within an enterprise, it cannot be applied to repositories owned by individuals or regular organizations."

Note: This function appends passed data to existing values

fn spec.forProvider.rules.withCommitMessagePattern

withCommitMessagePattern(commitMessagePattern)

"(Block List, Max: 1) Parameters to be used for the commit_message_pattern rule. This rule only applies to repositories within an enterprise, it cannot be applied to repositories owned by individuals or regular organizations. (see below for nested schema)\nParameters to be used for the commit_message_pattern rule. This rule only applies to repositories within an enterprise, it cannot be applied to repositories owned by individuals or regular organizations."

fn spec.forProvider.rules.withCommitMessagePatternMixin

withCommitMessagePatternMixin(commitMessagePattern)

"(Block List, Max: 1) Parameters to be used for the commit_message_pattern rule. This rule only applies to repositories within an enterprise, it cannot be applied to repositories owned by individuals or regular organizations. (see below for nested schema)\nParameters to be used for the commit_message_pattern rule. This rule only applies to repositories within an enterprise, it cannot be applied to repositories owned by individuals or regular organizations."

Note: This function appends passed data to existing values

fn spec.forProvider.rules.withCommitterEmailPattern

withCommitterEmailPattern(committerEmailPattern)

"(Block List, Max: 1) Parameters to be used for the committer_email_pattern rule. This rule only applies to repositories within an enterprise, it cannot be applied to repositories owned by individuals or regular organizations. (see below for nested schema)\nParameters to be used for the committer_email_pattern rule. This rule only applies to repositories within an enterprise, it cannot be applied to repositories owned by individuals or regular organizations."

fn spec.forProvider.rules.withCommitterEmailPatternMixin

withCommitterEmailPatternMixin(committerEmailPattern)

"(Block List, Max: 1) Parameters to be used for the committer_email_pattern rule. This rule only applies to repositories within an enterprise, it cannot be applied to repositories owned by individuals or regular organizations. (see below for nested schema)\nParameters to be used for the committer_email_pattern rule. This rule only applies to repositories within an enterprise, it cannot be applied to repositories owned by individuals or regular organizations."

Note: This function appends passed data to existing values

fn spec.forProvider.rules.withCreation

withCreation(creation)

"(Boolean) Only allow users with bypass permission to create matching refs.\nOnly allow users with bypass permission to create matching refs."

fn spec.forProvider.rules.withDeletion

withDeletion(deletion)

"(Boolean) Only allow users with bypass permissions to delete matching refs.\nOnly allow users with bypass permissions to delete matching refs."

fn spec.forProvider.rules.withMergeQueue

withMergeQueue(mergeQueue)

"(Block List, Max: 1) Merges must be performed via a merge queue.\nMerges must be performed via a merge queue."

fn spec.forProvider.rules.withMergeQueueMixin

withMergeQueueMixin(mergeQueue)

"(Block List, Max: 1) Merges must be performed via a merge queue.\nMerges must be performed via a merge queue."

Note: This function appends passed data to existing values

fn spec.forProvider.rules.withNonFastForward

withNonFastForward(nonFastForward)

"(Boolean) Prevent users with push access from force pushing to branches.\nPrevent users with push access from force pushing to branches."

fn spec.forProvider.rules.withPullRequest

withPullRequest(pullRequest)

"(Block List, Max: 1) Require all commits be made to a non-target branch and submitted via a pull request before they can be merged. (see below for nested schema)\nRequire all commits be made to a non-target branch and submitted via a pull request before they can be merged."

fn spec.forProvider.rules.withPullRequestMixin

withPullRequestMixin(pullRequest)

"(Block List, Max: 1) Require all commits be made to a non-target branch and submitted via a pull request before they can be merged. (see below for nested schema)\nRequire all commits be made to a non-target branch and submitted via a pull request before they can be merged."

Note: This function appends passed data to existing values

fn spec.forProvider.rules.withRequiredCodeScanning

withRequiredCodeScanning(requiredCodeScanning)

"(Block List, Max: 1) Define which tools must provide code scanning results before the reference is updated. When configured, code scanning must be enabled and have results for both the commit and the reference being updated. Multiple code scanning tools can be specified. (see below for nested schema)\nChoose which tools must provide code scanning results before the reference is updated. When configured, code scanning must be enabled and have results for both the commit and the reference being updated."

fn spec.forProvider.rules.withRequiredCodeScanningMixin

withRequiredCodeScanningMixin(requiredCodeScanning)

"(Block List, Max: 1) Define which tools must provide code scanning results before the reference is updated. When configured, code scanning must be enabled and have results for both the commit and the reference being updated. Multiple code scanning tools can be specified. (see below for nested schema)\nChoose which tools must provide code scanning results before the reference is updated. When configured, code scanning must be enabled and have results for both the commit and the reference being updated."

Note: This function appends passed data to existing values

fn spec.forProvider.rules.withRequiredDeployments

withRequiredDeployments(requiredDeployments)

"(Block List, Max: 1) Choose which environments must be successfully deployed to before branches can be merged into a branch that matches this rule. (see below for nested schema)\nChoose which environments must be successfully deployed to before branches can be merged into a branch that matches this rule."

fn spec.forProvider.rules.withRequiredDeploymentsMixin

withRequiredDeploymentsMixin(requiredDeployments)

"(Block List, Max: 1) Choose which environments must be successfully deployed to before branches can be merged into a branch that matches this rule. (see below for nested schema)\nChoose which environments must be successfully deployed to before branches can be merged into a branch that matches this rule."

Note: This function appends passed data to existing values

fn spec.forProvider.rules.withRequiredLinearHistory

withRequiredLinearHistory(requiredLinearHistory)

"(Boolean) Prevent merge commits from being pushed to matching branches.\nPrevent merge commits from being pushed to matching branches."

fn spec.forProvider.rules.withRequiredSignatures

withRequiredSignatures(requiredSignatures)

"(Boolean) Commits pushed to matching branches must have verified signatures.\nCommits pushed to matching branches must have verified signatures."

fn spec.forProvider.rules.withRequiredStatusChecks

withRequiredStatusChecks(requiredStatusChecks)

"(Block List, Max: 1) 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. (see below for nested schema)\nChoose 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."

fn spec.forProvider.rules.withRequiredStatusChecksMixin

withRequiredStatusChecksMixin(requiredStatusChecks)

"(Block List, Max: 1) 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. (see below for nested schema)\nChoose 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."

Note: This function appends passed data to existing values

fn spec.forProvider.rules.withTagNamePattern

withTagNamePattern(tagNamePattern)

"(Block List, Max: 1) 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 applied to rulesets with target tag. (see below for nested schema)\nParameters 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."

fn spec.forProvider.rules.withTagNamePatternMixin

withTagNamePatternMixin(tagNamePattern)

"(Block List, Max: 1) 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 applied to rulesets with target tag. (see below for nested schema)\nParameters 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."

Note: This function appends passed data to existing values

fn spec.forProvider.rules.withUpdate

withUpdate(update)

"(Boolean) Only allow users with bypass permission to update matching refs.\nOnly allow users with bypass permission to update matching refs."

fn spec.forProvider.rules.withUpdateAllowsFetchAndMerge

withUpdateAllowsFetchAndMerge(updateAllowsFetchAndMerge)

"(Boolean) Branch can pull changes from its upstream repository. This is only applicable to forked repositories. Requires update to be set to true. Note: behaviour is affected by a known bug on the GitHub side which may cause issues when using this parameter.\nBranch can pull changes from its upstream repository. This is only applicable to forked repositories. Requires update to be set to true."

obj spec.forProvider.rules.branchNamePattern

"(Block List, Max: 1) 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 applied to rulesets with target branch. (see below for nested schema)\nParameters 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."

fn spec.forProvider.rules.branchNamePattern.withName

withName(name)

"(String) How this rule will appear to users.\nHow this rule will appear to users."

fn spec.forProvider.rules.branchNamePattern.withNegate

withNegate(negate)

"(Boolean) If true, the rule will fail if the pattern matches.\nIf true, the rule will fail if the pattern matches."

fn spec.forProvider.rules.branchNamePattern.withOperator

withOperator(operator)

"(String) The operator to use for matching. Can be one of: starts_with, ends_with, contains, regex.\nThe operator to use for matching. Can be one of: starts_with, ends_with, contains, regex."

fn spec.forProvider.rules.branchNamePattern.withPattern

withPattern(pattern)

"(String) The pattern to match with.\nThe pattern to match with."

obj spec.forProvider.rules.commitAuthorEmailPattern

"(Block List, Max: 1) Parameters to be used for the commit_author_email_pattern rule. This rule only applies to repositories within an enterprise, it cannot be applied to repositories owned by individuals or regular organizations. (see below for nested schema)\nParameters to be used for the commit_author_email_pattern rule. This rule only applies to repositories within an enterprise, it cannot be applied to repositories owned by individuals or regular organizations."

fn spec.forProvider.rules.commitAuthorEmailPattern.withName

withName(name)

"(String) How this rule will appear to users.\nHow this rule will appear to users."

fn spec.forProvider.rules.commitAuthorEmailPattern.withNegate

withNegate(negate)

"(Boolean) If true, the rule will fail if the pattern matches.\nIf true, the rule will fail if the pattern matches."

fn spec.forProvider.rules.commitAuthorEmailPattern.withOperator

withOperator(operator)

"(String) The operator to use for matching. Can be one of: starts_with, ends_with, contains, regex.\nThe operator to use for matching. Can be one of: starts_with, ends_with, contains, regex."

fn spec.forProvider.rules.commitAuthorEmailPattern.withPattern

withPattern(pattern)

"(String) The pattern to match with.\nThe pattern to match with."

obj spec.forProvider.rules.commitMessagePattern

"(Block List, Max: 1) Parameters to be used for the commit_message_pattern rule. This rule only applies to repositories within an enterprise, it cannot be applied to repositories owned by individuals or regular organizations. (see below for nested schema)\nParameters to be used for the commit_message_pattern rule. This rule only applies to repositories within an enterprise, it cannot be applied to repositories owned by individuals or regular organizations."

fn spec.forProvider.rules.commitMessagePattern.withName

withName(name)

"(String) How this rule will appear to users.\nHow this rule will appear to users."

fn spec.forProvider.rules.commitMessagePattern.withNegate

withNegate(negate)

"(Boolean) If true, the rule will fail if the pattern matches.\nIf true, the rule will fail if the pattern matches."

fn spec.forProvider.rules.commitMessagePattern.withOperator

withOperator(operator)

"(String) The operator to use for matching. Can be one of: starts_with, ends_with, contains, regex.\nThe operator to use for matching. Can be one of: starts_with, ends_with, contains, regex."

fn spec.forProvider.rules.commitMessagePattern.withPattern

withPattern(pattern)

"(String) The pattern to match with.\nThe pattern to match with."

obj spec.forProvider.rules.committerEmailPattern

"(Block List, Max: 1) Parameters to be used for the committer_email_pattern rule. This rule only applies to repositories within an enterprise, it cannot be applied to repositories owned by individuals or regular organizations. (see below for nested schema)\nParameters to be used for the committer_email_pattern rule. This rule only applies to repositories within an enterprise, it cannot be applied to repositories owned by individuals or regular organizations."

fn spec.forProvider.rules.committerEmailPattern.withName

withName(name)

"(String) How this rule will appear to users.\nHow this rule will appear to users."

fn spec.forProvider.rules.committerEmailPattern.withNegate

withNegate(negate)

"(Boolean) If true, the rule will fail if the pattern matches.\nIf true, the rule will fail if the pattern matches."

fn spec.forProvider.rules.committerEmailPattern.withOperator

withOperator(operator)

"(String) The operator to use for matching. Can be one of: starts_with, ends_with, contains, regex.\nThe operator to use for matching. Can be one of: starts_with, ends_with, contains, regex."

fn spec.forProvider.rules.committerEmailPattern.withPattern

withPattern(pattern)

"(String) The pattern to match with.\nThe pattern to match with."

obj spec.forProvider.rules.mergeQueue

"(Block List, Max: 1) Merges must be performed via a merge queue.\nMerges must be performed via a merge queue."

fn spec.forProvider.rules.mergeQueue.withCheckResponseTimeoutMinutes

withCheckResponseTimeoutMinutes(checkResponseTimeoutMinutes)

"(Number)Maximum time for a required status check to report a conclusion. After this much time has elapsed, checks that have not reported a conclusion will be assumed to have failed. Defaults to 60.\nMaximum time for a required status check to report a conclusion. After this much time has elapsed, checks that have not reported a conclusion will be assumed to have failed. Defaults to 60."

fn spec.forProvider.rules.mergeQueue.withGroupingStrategy

withGroupingStrategy(groupingStrategy)

"(String)When set to ALLGREEN, the merge commit created by merge queue for each PR in the group must pass all required checks to merge. When set to HEADGREEN, only the commit at the head of the merge group, i.e. the commit containing changes from all of the PRs in the group, must pass its required checks to merge. Can be one of: ALLGREEN, HEADGREEN. Defaults to ALLGREEN.\nWhen set to ALLGREEN, the merge commit created by merge queue for each PR in the group must pass all required checks to merge. When set to HEADGREEN, only the commit at the head of the merge group, i.e. the commit containing changes from all of the PRs in the group, must pass its required checks to merge. Can be one of: ALLGREEN, HEADGREEN. Defaults to ALLGREEN."

fn spec.forProvider.rules.mergeQueue.withMaxEntriesToBuild

withMaxEntriesToBuild(maxEntriesToBuild)

"(Number) Limit the number of queued pull requests requesting checks and workflow runs at the same time. Defaults to 5.\nLimit the number of queued pull requests requesting checks and workflow runs at the same time. Defaults to 5."

fn spec.forProvider.rules.mergeQueue.withMaxEntriesToMerge

withMaxEntriesToMerge(maxEntriesToMerge)

"(Number) Limit the number of queued pull requests requesting checks and workflow runs at the same time. Defaults to 5.\nThe maximum number of PRs that will be merged together in a group. Defaults to 5."

fn spec.forProvider.rules.mergeQueue.withMergeMethod

withMergeMethod(mergeMethod)

"(String) Method to use when merging changes from queued pull requests. Can be one of: MERGE, SQUASH, REBASE. Defaults to MERGE.\nMethod to use when merging changes from queued pull requests. Can be one of: MERGE, SQUASH, REBASE. Defaults to MERGE."

fn spec.forProvider.rules.mergeQueue.withMinEntriesToMerge

withMinEntriesToMerge(minEntriesToMerge)

"(Number) The minimum number of PRs that will be merged together in a group. Defaults to 1.\nThe minimum number of PRs that will be merged together in a group. Defaults to 1."

fn spec.forProvider.rules.mergeQueue.withMinEntriesToMergeWaitMinutes

withMinEntriesToMergeWaitMinutes(minEntriesToMergeWaitMinutes)

"(Number) The time merge queue should wait after the first PR is added to the queue for the minimum group size to be met. After this time has elapsed, the minimum group size will be ignored and a smaller group will be merged. Defaults to 5.\nThe time merge queue should wait after the first PR is added to the queue for the minimum group size to be met. After this time has elapsed, the minimum group size will be ignored and a smaller group will be merged. Defaults to 5."

obj spec.forProvider.rules.pullRequest

"(Block List, Max: 1) Require all commits be made to a non-target branch and submitted via a pull request before they can be merged. (see below for nested schema)\nRequire all commits be made to a non-target branch and submitted via a pull request before they can be merged."

fn spec.forProvider.rules.pullRequest.withDismissStaleReviewsOnPush

withDismissStaleReviewsOnPush(dismissStaleReviewsOnPush)

"(Boolean) New, reviewable commits pushed will dismiss previous pull request review approvals. Defaults to false.\nNew, reviewable commits pushed will dismiss previous pull request review approvals. Defaults to false."

fn spec.forProvider.rules.pullRequest.withRequireCodeOwnerReview

withRequireCodeOwnerReview(requireCodeOwnerReview)

"(Boolean) Require an approving review in pull requests that modify files that have a designated code owner. Defaults to false.\nRequire an approving review in pull requests that modify files that have a designated code owner. Defaults to false."

fn spec.forProvider.rules.pullRequest.withRequireLastPushApproval

withRequireLastPushApproval(requireLastPushApproval)

"(Boolean) Whether the most recent reviewable push must be approved by someone other than the person who pushed it. Defaults to false.\nWhether the most recent reviewable push must be approved by someone other than the person who pushed it. Defaults to false."

fn spec.forProvider.rules.pullRequest.withRequiredApprovingReviewCount

withRequiredApprovingReviewCount(requiredApprovingReviewCount)

"(Number) The number of approving reviews that are required before a pull request can be merged. Defaults to 0.\nThe number of approving reviews that are required before a pull request can be merged. Defaults to 0."

fn spec.forProvider.rules.pullRequest.withRequiredReviewThreadResolution

withRequiredReviewThreadResolution(requiredReviewThreadResolution)

"(Boolean) All conversations on code must be resolved before a pull request can be merged. Defaults to false.\nAll conversations on code must be resolved before a pull request can be merged. Defaults to false."

obj spec.forProvider.rules.requiredCodeScanning

"(Block List, Max: 1) Define which tools must provide code scanning results before the reference is updated. When configured, code scanning must be enabled and have results for both the commit and the reference being updated. Multiple code scanning tools can be specified. (see below for nested schema)\nChoose which tools must provide code scanning results before the reference is updated. When configured, code scanning must be enabled and have results for both the commit and the reference being updated."

fn spec.forProvider.rules.requiredCodeScanning.withRequiredCodeScanningTool

withRequiredCodeScanningTool(requiredCodeScanningTool)

"(Block Set, Min: 1) Actions code scanning tools that are required. Multiple can be defined. (see below for nested schema)\nTools that must provide code scanning results for this rule to pass."

fn spec.forProvider.rules.requiredCodeScanning.withRequiredCodeScanningToolMixin

withRequiredCodeScanningToolMixin(requiredCodeScanningTool)

"(Block Set, Min: 1) Actions code scanning tools that are required. Multiple can be defined. (see below for nested schema)\nTools that must provide code scanning results for this rule to pass."

Note: This function appends passed data to existing values

obj spec.forProvider.rules.requiredCodeScanning.requiredCodeScanningTool

"(Block Set, Min: 1) Actions code scanning tools that are required. Multiple can be defined. (see below for nested schema)\nTools that must provide code scanning results for this rule to pass."

fn spec.forProvider.rules.requiredCodeScanning.requiredCodeScanningTool.withAlertsThreshold

withAlertsThreshold(alertsThreshold)

"(String) The severity level at which code scanning results that raise alerts block a reference update. Can be one of: none, errors, errors_and_warnings, all.\nThe severity level at which code scanning results that raise alerts block a reference update. Can be one of: none, errors, errors_and_warnings, all."

fn spec.forProvider.rules.requiredCodeScanning.requiredCodeScanningTool.withSecurityAlertsThreshold

withSecurityAlertsThreshold(securityAlertsThreshold)

"(String) The severity level at which code scanning results that raise security alerts block a reference update. Can be one of: none, critical, high_or_higher, medium_or_higher, all.\nThe severity level at which code scanning results that raise security alerts block a reference update. Can be one of: none, critical, high_or_higher, medium_or_higher, all."

fn spec.forProvider.rules.requiredCodeScanning.requiredCodeScanningTool.withTool

withTool(tool)

"(String) The name of a code scanning tool.\nThe name of a code scanning tool"

obj spec.forProvider.rules.requiredDeployments

"(Block List, Max: 1) Choose which environments must be successfully deployed to before branches can be merged into a branch that matches this rule. (see below for nested schema)\nChoose which environments must be successfully deployed to before branches can be merged into a branch that matches this rule."

fn spec.forProvider.rules.requiredDeployments.withRequiredDeploymentEnvironments

withRequiredDeploymentEnvironments(requiredDeploymentEnvironments)

"(List of String) The environments that must be successfully deployed to before branches can be merged.\nThe environments that must be successfully deployed to before branches can be merged."

fn spec.forProvider.rules.requiredDeployments.withRequiredDeploymentEnvironmentsMixin

withRequiredDeploymentEnvironmentsMixin(requiredDeploymentEnvironments)

"(List of String) The environments that must be successfully deployed to before branches can be merged.\nThe environments that must be successfully deployed to before branches can be merged."

Note: This function appends passed data to existing values

obj spec.forProvider.rules.requiredStatusChecks

"(Block List, Max: 1) 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. (see below for nested schema)\nChoose 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."

fn spec.forProvider.rules.requiredStatusChecks.withDoNotEnforceOnCreate

withDoNotEnforceOnCreate(doNotEnforceOnCreate)

"(Boolean) Allow repositories and branches to be created if a check would otherwise prohibit it. Defaults to false.\nAllow repositories and branches to be created if a check would otherwise prohibit it."

fn spec.forProvider.rules.requiredStatusChecks.withRequiredCheck

withRequiredCheck(requiredCheck)

"(Block Set, Min: 1) Status checks that are required. Several can be defined. (see below for nested schema)\nStatus checks that are required. Several can be defined."

fn spec.forProvider.rules.requiredStatusChecks.withRequiredCheckMixin

withRequiredCheckMixin(requiredCheck)

"(Block Set, Min: 1) Status checks that are required. Several can be defined. (see below for nested schema)\nStatus checks that are required. Several can be defined."

Note: This function appends passed data to existing values

fn spec.forProvider.rules.requiredStatusChecks.withStrictRequiredStatusChecksPolicy

withStrictRequiredStatusChecksPolicy(strictRequiredStatusChecksPolicy)

"(Boolean) Whether pull requests targeting a matching branch must be tested with the latest code. This setting will not take effect unless at least one status check is enabled. Defaults to false.\nWhether pull requests targeting a matching branch must be tested with the latest code. This setting will not take effect unless at least one status check is enabled. Defaults to false."

obj spec.forProvider.rules.requiredStatusChecks.requiredCheck

"(Block Set, Min: 1) Status checks that are required. Several can be defined. (see below for nested schema)\nStatus checks that are required. Several can be defined."

fn spec.forProvider.rules.requiredStatusChecks.requiredCheck.withContext

withContext(context)

"(String) The status check context name that must be present on the commit.\nThe status check context name that must be present on the commit."

fn spec.forProvider.rules.requiredStatusChecks.requiredCheck.withIntegrationId

withIntegrationId(integrationId)

"(Number) The optional integration ID that this status check must originate from. It's a GitHub App ID, which can be obtained by following instructions from the Get an App API docs.\nThe optional integration ID that this status check must originate from."

obj spec.forProvider.rules.tagNamePattern

"(Block List, Max: 1) 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 applied to rulesets with target tag. (see below for nested schema)\nParameters 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."

fn spec.forProvider.rules.tagNamePattern.withName

withName(name)

"(String) How this rule will appear to users.\nHow this rule will appear to users."

fn spec.forProvider.rules.tagNamePattern.withNegate

withNegate(negate)

"(Boolean) If true, the rule will fail if the pattern matches.\nIf true, the rule will fail if the pattern matches."

fn spec.forProvider.rules.tagNamePattern.withOperator

withOperator(operator)

"(String) The operator to use for matching. Can be one of: starts_with, ends_with, contains, regex.\nThe operator to use for matching. Can be one of: starts_with, ends_with, contains, regex."

fn spec.forProvider.rules.tagNamePattern.withPattern

withPattern(pattern)

"(String) The pattern to match with.\nThe pattern to match with."

obj spec.initProvider

"THIS IS A BETA FIELD. It will be honored\nunless the Management Policies feature flag is disabled.\nInitProvider holds the same fields as ForProvider, with the exception\nof Identifier and other resource reference fields. The fields that are\nin InitProvider are merged into ForProvider when the resource is created.\nThe same fields are also added to the terraform ignore_changes hook, to\navoid updating them after creation. This is useful for fields that are\nrequired on creation, but we do not desire to update them after creation,\nfor example because of an external controller is managing them, like an\nautoscaler."

fn spec.initProvider.withBypassActors

withBypassActors(bypassActors)

"(Block List) The actors that can bypass the rules in this ruleset. (see below for nested schema)\nThe actors that can bypass the rules in this ruleset."

fn spec.initProvider.withBypassActorsMixin

withBypassActorsMixin(bypassActors)

"(Block List) The actors that can bypass the rules in this ruleset. (see below for nested schema)\nThe actors that can bypass the rules in this ruleset."

Note: This function appends passed data to existing values

fn spec.initProvider.withConditions

withConditions(conditions)

"(Block List, Max: 1) Parameters for a repository ruleset ref name condition. (see below for nested schema)\nParameters for a repository ruleset ref name condition."

fn spec.initProvider.withConditionsMixin

withConditionsMixin(conditions)

"(Block List, Max: 1) Parameters for a repository ruleset ref name condition. (see below for nested schema)\nParameters for a repository ruleset ref name condition."

Note: This function appends passed data to existing values

fn spec.initProvider.withEnforcement

withEnforcement(enforcement)

"(String) Possible values for Enforcement are disabled, active, evaluate. Note: evaluate is currently only supported for owners of type organization.\nPossible values for Enforcement are disabled, active, evaluate. Note: evaluate is currently only supported for owners of type organization."

fn spec.initProvider.withName

withName(name)

"(String) The name of the ruleset.\nThe name of the ruleset."

fn spec.initProvider.withRepository

withRepository(repository)

"(String) Name of the repository to apply rulset to.\nName of the repository to apply rulset to."

fn spec.initProvider.withRules

withRules(rules)

"(Block List, Min: 1, Max: 1) Rules within the ruleset. (see below for nested schema)\nRules within the ruleset."

fn spec.initProvider.withRulesMixin

withRulesMixin(rules)

"(Block List, Min: 1, Max: 1) Rules within the ruleset. (see below for nested schema)\nRules within the ruleset."

Note: This function appends passed data to existing values

fn spec.initProvider.withTarget

withTarget(target)

"(String) Possible values are branch and tag.\nPossible values are branch and tag."

obj spec.initProvider.bypassActors

"(Block List) The actors that can bypass the rules in this ruleset. (see below for nested schema)\nThe actors that can bypass the rules in this ruleset."

fn spec.initProvider.bypassActors.withActorId

withActorId(actorId)

"(Number) The ID of the actor that can bypass a ruleset. If actor_type is Integration, actor_id is a GitHub App ID. App ID can be obtained by following instructions from the Get an App API docs\nThe ID of the actor that can bypass a ruleset. When actor_type is OrganizationAdmin, this should be set to 1."

fn spec.initProvider.bypassActors.withActorType

withActorType(actorType)

"(String) The type of actor that can bypass a ruleset. Can be one of: RepositoryRole, Team, Integration, OrganizationAdmin.\nThe type of actor that can bypass a ruleset. Can be one of: RepositoryRole, Team, Integration, OrganizationAdmin."

fn spec.initProvider.bypassActors.withBypassMode

withBypassMode(bypassMode)

"(String) When the specified actor can bypass the ruleset. pull_request means that an actor can only bypass rules on pull requests. Can be one of: always, pull_request.\nWhen the specified actor can bypass the ruleset. pull_request means that an actor can only bypass rules on pull requests. Can be one of: always, pull_request."

obj spec.initProvider.conditions

"(Block List, Max: 1) Parameters for a repository ruleset ref name condition. (see below for nested schema)\nParameters for a repository ruleset ref name condition."

fn spec.initProvider.conditions.withRefName

withRefName(refName)

"(Block List, Min: 1, Max: 1) (see below for nested schema)"

fn spec.initProvider.conditions.withRefNameMixin

withRefNameMixin(refName)

"(Block List, Min: 1, Max: 1) (see below for nested schema)"

Note: This function appends passed data to existing values

obj spec.initProvider.conditions.refName

"(Block List, Min: 1, Max: 1) (see below for nested schema)"

fn spec.initProvider.conditions.refName.withExclude

withExclude(exclude)

"(List of String) Array of ref names or patterns to exclude. The condition will not pass if any of these patterns match.\nArray of ref names or patterns to exclude. The condition will not pass if any of these patterns match."

fn spec.initProvider.conditions.refName.withExcludeMixin

withExcludeMixin(exclude)

"(List of String) Array of ref names or patterns to exclude. The condition will not pass if any of these patterns match.\nArray of ref names or patterns to exclude. The condition will not pass if any of these patterns match."

Note: This function appends passed data to existing values

fn spec.initProvider.conditions.refName.withInclude

withInclude(include)

"(List of String) 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.\nArray 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."

fn spec.initProvider.conditions.refName.withIncludeMixin

withIncludeMixin(include)

"(List of String) 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.\nArray 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."

Note: This function appends passed data to existing values

obj spec.initProvider.repositoryRef

"Reference to a Repository in repo to populate repository."

fn spec.initProvider.repositoryRef.withName

withName(name)

"Name of the referenced object."

fn spec.initProvider.repositoryRef.withNamespace

withNamespace(namespace)

"Namespace of the referenced object"

obj spec.initProvider.repositoryRef.policy

"Policies for referencing."

fn spec.initProvider.repositoryRef.policy.withResolution

withResolution(resolution)

"Resolution specifies whether resolution of this reference is required.\nThe default is 'Required', which means the reconcile will fail if the\nreference cannot be resolved. 'Optional' means this reference will be\na no-op if it cannot be resolved."

fn spec.initProvider.repositoryRef.policy.withResolve

withResolve(resolve)

"Resolve specifies when this reference should be resolved. The default\nis 'IfNotPresent', which will attempt to resolve the reference only when\nthe corresponding field is not present. Use 'Always' to resolve the\nreference on every reconcile."

obj spec.initProvider.repositorySelector

"Selector for a Repository in repo to populate repository."

fn spec.initProvider.repositorySelector.withMatchControllerRef

withMatchControllerRef(matchControllerRef)

"MatchControllerRef ensures an object with the same controller reference\nas the selecting object is selected."

fn spec.initProvider.repositorySelector.withMatchLabels

withMatchLabels(matchLabels)

"MatchLabels ensures an object with matching labels is selected."

fn spec.initProvider.repositorySelector.withMatchLabelsMixin

withMatchLabelsMixin(matchLabels)

"MatchLabels ensures an object with matching labels is selected."

Note: This function appends passed data to existing values

fn spec.initProvider.repositorySelector.withNamespace

withNamespace(namespace)

"Namespace for the selector"

obj spec.initProvider.repositorySelector.policy

"Policies for selection."

fn spec.initProvider.repositorySelector.policy.withResolution

withResolution(resolution)

"Resolution specifies whether resolution of this reference is required.\nThe default is 'Required', which means the reconcile will fail if the\nreference cannot be resolved. 'Optional' means this reference will be\na no-op if it cannot be resolved."

fn spec.initProvider.repositorySelector.policy.withResolve

withResolve(resolve)

"Resolve specifies when this reference should be resolved. The default\nis 'IfNotPresent', which will attempt to resolve the reference only when\nthe corresponding field is not present. Use 'Always' to resolve the\nreference on every reconcile."

obj spec.initProvider.rules

"(Block List, Min: 1, Max: 1) Rules within the ruleset. (see below for nested schema)\nRules within the ruleset."

fn spec.initProvider.rules.withBranchNamePattern

withBranchNamePattern(branchNamePattern)

"(Block List, Max: 1) 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 applied to rulesets with target branch. (see below for nested schema)\nParameters 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."

fn spec.initProvider.rules.withBranchNamePatternMixin

withBranchNamePatternMixin(branchNamePattern)

"(Block List, Max: 1) 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 applied to rulesets with target branch. (see below for nested schema)\nParameters 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."

Note: This function appends passed data to existing values

fn spec.initProvider.rules.withCommitAuthorEmailPattern

withCommitAuthorEmailPattern(commitAuthorEmailPattern)

"(Block List, Max: 1) Parameters to be used for the commit_author_email_pattern rule. This rule only applies to repositories within an enterprise, it cannot be applied to repositories owned by individuals or regular organizations. (see below for nested schema)\nParameters to be used for the commit_author_email_pattern rule. This rule only applies to repositories within an enterprise, it cannot be applied to repositories owned by individuals or regular organizations."

fn spec.initProvider.rules.withCommitAuthorEmailPatternMixin

withCommitAuthorEmailPatternMixin(commitAuthorEmailPattern)

"(Block List, Max: 1) Parameters to be used for the commit_author_email_pattern rule. This rule only applies to repositories within an enterprise, it cannot be applied to repositories owned by individuals or regular organizations. (see below for nested schema)\nParameters to be used for the commit_author_email_pattern rule. This rule only applies to repositories within an enterprise, it cannot be applied to repositories owned by individuals or regular organizations."

Note: This function appends passed data to existing values

fn spec.initProvider.rules.withCommitMessagePattern

withCommitMessagePattern(commitMessagePattern)

"(Block List, Max: 1) Parameters to be used for the commit_message_pattern rule. This rule only applies to repositories within an enterprise, it cannot be applied to repositories owned by individuals or regular organizations. (see below for nested schema)\nParameters to be used for the commit_message_pattern rule. This rule only applies to repositories within an enterprise, it cannot be applied to repositories owned by individuals or regular organizations."

fn spec.initProvider.rules.withCommitMessagePatternMixin

withCommitMessagePatternMixin(commitMessagePattern)

"(Block List, Max: 1) Parameters to be used for the commit_message_pattern rule. This rule only applies to repositories within an enterprise, it cannot be applied to repositories owned by individuals or regular organizations. (see below for nested schema)\nParameters to be used for the commit_message_pattern rule. This rule only applies to repositories within an enterprise, it cannot be applied to repositories owned by individuals or regular organizations."

Note: This function appends passed data to existing values

fn spec.initProvider.rules.withCommitterEmailPattern

withCommitterEmailPattern(committerEmailPattern)

"(Block List, Max: 1) Parameters to be used for the committer_email_pattern rule. This rule only applies to repositories within an enterprise, it cannot be applied to repositories owned by individuals or regular organizations. (see below for nested schema)\nParameters to be used for the committer_email_pattern rule. This rule only applies to repositories within an enterprise, it cannot be applied to repositories owned by individuals or regular organizations."

fn spec.initProvider.rules.withCommitterEmailPatternMixin

withCommitterEmailPatternMixin(committerEmailPattern)

"(Block List, Max: 1) Parameters to be used for the committer_email_pattern rule. This rule only applies to repositories within an enterprise, it cannot be applied to repositories owned by individuals or regular organizations. (see below for nested schema)\nParameters to be used for the committer_email_pattern rule. This rule only applies to repositories within an enterprise, it cannot be applied to repositories owned by individuals or regular organizations."

Note: This function appends passed data to existing values

fn spec.initProvider.rules.withCreation

withCreation(creation)

"(Boolean) Only allow users with bypass permission to create matching refs.\nOnly allow users with bypass permission to create matching refs."

fn spec.initProvider.rules.withDeletion

withDeletion(deletion)

"(Boolean) Only allow users with bypass permissions to delete matching refs.\nOnly allow users with bypass permissions to delete matching refs."

fn spec.initProvider.rules.withMergeQueue

withMergeQueue(mergeQueue)

"(Block List, Max: 1) Merges must be performed via a merge queue.\nMerges must be performed via a merge queue."

fn spec.initProvider.rules.withMergeQueueMixin

withMergeQueueMixin(mergeQueue)

"(Block List, Max: 1) Merges must be performed via a merge queue.\nMerges must be performed via a merge queue."

Note: This function appends passed data to existing values

fn spec.initProvider.rules.withNonFastForward

withNonFastForward(nonFastForward)

"(Boolean) Prevent users with push access from force pushing to branches.\nPrevent users with push access from force pushing to branches."

fn spec.initProvider.rules.withPullRequest

withPullRequest(pullRequest)

"(Block List, Max: 1) Require all commits be made to a non-target branch and submitted via a pull request before they can be merged. (see below for nested schema)\nRequire all commits be made to a non-target branch and submitted via a pull request before they can be merged."

fn spec.initProvider.rules.withPullRequestMixin

withPullRequestMixin(pullRequest)

"(Block List, Max: 1) Require all commits be made to a non-target branch and submitted via a pull request before they can be merged. (see below for nested schema)\nRequire all commits be made to a non-target branch and submitted via a pull request before they can be merged."

Note: This function appends passed data to existing values

fn spec.initProvider.rules.withRequiredCodeScanning

withRequiredCodeScanning(requiredCodeScanning)

"(Block List, Max: 1) Define which tools must provide code scanning results before the reference is updated. When configured, code scanning must be enabled and have results for both the commit and the reference being updated. Multiple code scanning tools can be specified. (see below for nested schema)\nChoose which tools must provide code scanning results before the reference is updated. When configured, code scanning must be enabled and have results for both the commit and the reference being updated."

fn spec.initProvider.rules.withRequiredCodeScanningMixin

withRequiredCodeScanningMixin(requiredCodeScanning)

"(Block List, Max: 1) Define which tools must provide code scanning results before the reference is updated. When configured, code scanning must be enabled and have results for both the commit and the reference being updated. Multiple code scanning tools can be specified. (see below for nested schema)\nChoose which tools must provide code scanning results before the reference is updated. When configured, code scanning must be enabled and have results for both the commit and the reference being updated."

Note: This function appends passed data to existing values

fn spec.initProvider.rules.withRequiredDeployments

withRequiredDeployments(requiredDeployments)

"(Block List, Max: 1) Choose which environments must be successfully deployed to before branches can be merged into a branch that matches this rule. (see below for nested schema)\nChoose which environments must be successfully deployed to before branches can be merged into a branch that matches this rule."

fn spec.initProvider.rules.withRequiredDeploymentsMixin

withRequiredDeploymentsMixin(requiredDeployments)

"(Block List, Max: 1) Choose which environments must be successfully deployed to before branches can be merged into a branch that matches this rule. (see below for nested schema)\nChoose which environments must be successfully deployed to before branches can be merged into a branch that matches this rule."

Note: This function appends passed data to existing values

fn spec.initProvider.rules.withRequiredLinearHistory

withRequiredLinearHistory(requiredLinearHistory)

"(Boolean) Prevent merge commits from being pushed to matching branches.\nPrevent merge commits from being pushed to matching branches."

fn spec.initProvider.rules.withRequiredSignatures

withRequiredSignatures(requiredSignatures)

"(Boolean) Commits pushed to matching branches must have verified signatures.\nCommits pushed to matching branches must have verified signatures."

fn spec.initProvider.rules.withRequiredStatusChecks

withRequiredStatusChecks(requiredStatusChecks)

"(Block List, Max: 1) 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. (see below for nested schema)\nChoose 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."

fn spec.initProvider.rules.withRequiredStatusChecksMixin

withRequiredStatusChecksMixin(requiredStatusChecks)

"(Block List, Max: 1) 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. (see below for nested schema)\nChoose 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."

Note: This function appends passed data to existing values

fn spec.initProvider.rules.withTagNamePattern

withTagNamePattern(tagNamePattern)

"(Block List, Max: 1) 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 applied to rulesets with target tag. (see below for nested schema)\nParameters 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."

fn spec.initProvider.rules.withTagNamePatternMixin

withTagNamePatternMixin(tagNamePattern)

"(Block List, Max: 1) 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 applied to rulesets with target tag. (see below for nested schema)\nParameters 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."

Note: This function appends passed data to existing values

fn spec.initProvider.rules.withUpdate

withUpdate(update)

"(Boolean) Only allow users with bypass permission to update matching refs.\nOnly allow users with bypass permission to update matching refs."

fn spec.initProvider.rules.withUpdateAllowsFetchAndMerge

withUpdateAllowsFetchAndMerge(updateAllowsFetchAndMerge)

"(Boolean) Branch can pull changes from its upstream repository. This is only applicable to forked repositories. Requires update to be set to true. Note: behaviour is affected by a known bug on the GitHub side which may cause issues when using this parameter.\nBranch can pull changes from its upstream repository. This is only applicable to forked repositories. Requires update to be set to true."

obj spec.initProvider.rules.branchNamePattern

"(Block List, Max: 1) 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 applied to rulesets with target branch. (see below for nested schema)\nParameters 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."

fn spec.initProvider.rules.branchNamePattern.withName

withName(name)

"(String) How this rule will appear to users.\nHow this rule will appear to users."

fn spec.initProvider.rules.branchNamePattern.withNegate

withNegate(negate)

"(Boolean) If true, the rule will fail if the pattern matches.\nIf true, the rule will fail if the pattern matches."

fn spec.initProvider.rules.branchNamePattern.withOperator

withOperator(operator)

"(String) The operator to use for matching. Can be one of: starts_with, ends_with, contains, regex.\nThe operator to use for matching. Can be one of: starts_with, ends_with, contains, regex."

fn spec.initProvider.rules.branchNamePattern.withPattern

withPattern(pattern)

"(String) The pattern to match with.\nThe pattern to match with."

obj spec.initProvider.rules.commitAuthorEmailPattern

"(Block List, Max: 1) Parameters to be used for the commit_author_email_pattern rule. This rule only applies to repositories within an enterprise, it cannot be applied to repositories owned by individuals or regular organizations. (see below for nested schema)\nParameters to be used for the commit_author_email_pattern rule. This rule only applies to repositories within an enterprise, it cannot be applied to repositories owned by individuals or regular organizations."

fn spec.initProvider.rules.commitAuthorEmailPattern.withName

withName(name)

"(String) How this rule will appear to users.\nHow this rule will appear to users."

fn spec.initProvider.rules.commitAuthorEmailPattern.withNegate

withNegate(negate)

"(Boolean) If true, the rule will fail if the pattern matches.\nIf true, the rule will fail if the pattern matches."

fn spec.initProvider.rules.commitAuthorEmailPattern.withOperator

withOperator(operator)

"(String) The operator to use for matching. Can be one of: starts_with, ends_with, contains, regex.\nThe operator to use for matching. Can be one of: starts_with, ends_with, contains, regex."

fn spec.initProvider.rules.commitAuthorEmailPattern.withPattern

withPattern(pattern)

"(String) The pattern to match with.\nThe pattern to match with."

obj spec.initProvider.rules.commitMessagePattern

"(Block List, Max: 1) Parameters to be used for the commit_message_pattern rule. This rule only applies to repositories within an enterprise, it cannot be applied to repositories owned by individuals or regular organizations. (see below for nested schema)\nParameters to be used for the commit_message_pattern rule. This rule only applies to repositories within an enterprise, it cannot be applied to repositories owned by individuals or regular organizations."

fn spec.initProvider.rules.commitMessagePattern.withName

withName(name)

"(String) How this rule will appear to users.\nHow this rule will appear to users."

fn spec.initProvider.rules.commitMessagePattern.withNegate

withNegate(negate)

"(Boolean) If true, the rule will fail if the pattern matches.\nIf true, the rule will fail if the pattern matches."

fn spec.initProvider.rules.commitMessagePattern.withOperator

withOperator(operator)

"(String) The operator to use for matching. Can be one of: starts_with, ends_with, contains, regex.\nThe operator to use for matching. Can be one of: starts_with, ends_with, contains, regex."

fn spec.initProvider.rules.commitMessagePattern.withPattern

withPattern(pattern)

"(String) The pattern to match with.\nThe pattern to match with."

obj spec.initProvider.rules.committerEmailPattern

"(Block List, Max: 1) Parameters to be used for the committer_email_pattern rule. This rule only applies to repositories within an enterprise, it cannot be applied to repositories owned by individuals or regular organizations. (see below for nested schema)\nParameters to be used for the committer_email_pattern rule. This rule only applies to repositories within an enterprise, it cannot be applied to repositories owned by individuals or regular organizations."

fn spec.initProvider.rules.committerEmailPattern.withName

withName(name)

"(String) How this rule will appear to users.\nHow this rule will appear to users."

fn spec.initProvider.rules.committerEmailPattern.withNegate

withNegate(negate)

"(Boolean) If true, the rule will fail if the pattern matches.\nIf true, the rule will fail if the pattern matches."

fn spec.initProvider.rules.committerEmailPattern.withOperator

withOperator(operator)

"(String) The operator to use for matching. Can be one of: starts_with, ends_with, contains, regex.\nThe operator to use for matching. Can be one of: starts_with, ends_with, contains, regex."

fn spec.initProvider.rules.committerEmailPattern.withPattern

withPattern(pattern)

"(String) The pattern to match with.\nThe pattern to match with."

obj spec.initProvider.rules.mergeQueue

"(Block List, Max: 1) Merges must be performed via a merge queue.\nMerges must be performed via a merge queue."

fn spec.initProvider.rules.mergeQueue.withCheckResponseTimeoutMinutes

withCheckResponseTimeoutMinutes(checkResponseTimeoutMinutes)

"(Number)Maximum time for a required status check to report a conclusion. After this much time has elapsed, checks that have not reported a conclusion will be assumed to have failed. Defaults to 60.\nMaximum time for a required status check to report a conclusion. After this much time has elapsed, checks that have not reported a conclusion will be assumed to have failed. Defaults to 60."

fn spec.initProvider.rules.mergeQueue.withGroupingStrategy

withGroupingStrategy(groupingStrategy)

"(String)When set to ALLGREEN, the merge commit created by merge queue for each PR in the group must pass all required checks to merge. When set to HEADGREEN, only the commit at the head of the merge group, i.e. the commit containing changes from all of the PRs in the group, must pass its required checks to merge. Can be one of: ALLGREEN, HEADGREEN. Defaults to ALLGREEN.\nWhen set to ALLGREEN, the merge commit created by merge queue for each PR in the group must pass all required checks to merge. When set to HEADGREEN, only the commit at the head of the merge group, i.e. the commit containing changes from all of the PRs in the group, must pass its required checks to merge. Can be one of: ALLGREEN, HEADGREEN. Defaults to ALLGREEN."

fn spec.initProvider.rules.mergeQueue.withMaxEntriesToBuild

withMaxEntriesToBuild(maxEntriesToBuild)

"(Number) Limit the number of queued pull requests requesting checks and workflow runs at the same time. Defaults to 5.\nLimit the number of queued pull requests requesting checks and workflow runs at the same time. Defaults to 5."

fn spec.initProvider.rules.mergeQueue.withMaxEntriesToMerge

withMaxEntriesToMerge(maxEntriesToMerge)

"(Number) Limit the number of queued pull requests requesting checks and workflow runs at the same time. Defaults to 5.\nThe maximum number of PRs that will be merged together in a group. Defaults to 5."

fn spec.initProvider.rules.mergeQueue.withMergeMethod

withMergeMethod(mergeMethod)

"(String) Method to use when merging changes from queued pull requests. Can be one of: MERGE, SQUASH, REBASE. Defaults to MERGE.\nMethod to use when merging changes from queued pull requests. Can be one of: MERGE, SQUASH, REBASE. Defaults to MERGE."

fn spec.initProvider.rules.mergeQueue.withMinEntriesToMerge

withMinEntriesToMerge(minEntriesToMerge)

"(Number) The minimum number of PRs that will be merged together in a group. Defaults to 1.\nThe minimum number of PRs that will be merged together in a group. Defaults to 1."

fn spec.initProvider.rules.mergeQueue.withMinEntriesToMergeWaitMinutes

withMinEntriesToMergeWaitMinutes(minEntriesToMergeWaitMinutes)

"(Number) The time merge queue should wait after the first PR is added to the queue for the minimum group size to be met. After this time has elapsed, the minimum group size will be ignored and a smaller group will be merged. Defaults to 5.\nThe time merge queue should wait after the first PR is added to the queue for the minimum group size to be met. After this time has elapsed, the minimum group size will be ignored and a smaller group will be merged. Defaults to 5."

obj spec.initProvider.rules.pullRequest

"(Block List, Max: 1) Require all commits be made to a non-target branch and submitted via a pull request before they can be merged. (see below for nested schema)\nRequire all commits be made to a non-target branch and submitted via a pull request before they can be merged."

fn spec.initProvider.rules.pullRequest.withDismissStaleReviewsOnPush

withDismissStaleReviewsOnPush(dismissStaleReviewsOnPush)

"(Boolean) New, reviewable commits pushed will dismiss previous pull request review approvals. Defaults to false.\nNew, reviewable commits pushed will dismiss previous pull request review approvals. Defaults to false."

fn spec.initProvider.rules.pullRequest.withRequireCodeOwnerReview

withRequireCodeOwnerReview(requireCodeOwnerReview)

"(Boolean) Require an approving review in pull requests that modify files that have a designated code owner. Defaults to false.\nRequire an approving review in pull requests that modify files that have a designated code owner. Defaults to false."

fn spec.initProvider.rules.pullRequest.withRequireLastPushApproval

withRequireLastPushApproval(requireLastPushApproval)

"(Boolean) Whether the most recent reviewable push must be approved by someone other than the person who pushed it. Defaults to false.\nWhether the most recent reviewable push must be approved by someone other than the person who pushed it. Defaults to false."

fn spec.initProvider.rules.pullRequest.withRequiredApprovingReviewCount

withRequiredApprovingReviewCount(requiredApprovingReviewCount)

"(Number) The number of approving reviews that are required before a pull request can be merged. Defaults to 0.\nThe number of approving reviews that are required before a pull request can be merged. Defaults to 0."

fn spec.initProvider.rules.pullRequest.withRequiredReviewThreadResolution

withRequiredReviewThreadResolution(requiredReviewThreadResolution)

"(Boolean) All conversations on code must be resolved before a pull request can be merged. Defaults to false.\nAll conversations on code must be resolved before a pull request can be merged. Defaults to false."

obj spec.initProvider.rules.requiredCodeScanning

"(Block List, Max: 1) Define which tools must provide code scanning results before the reference is updated. When configured, code scanning must be enabled and have results for both the commit and the reference being updated. Multiple code scanning tools can be specified. (see below for nested schema)\nChoose which tools must provide code scanning results before the reference is updated. When configured, code scanning must be enabled and have results for both the commit and the reference being updated."

fn spec.initProvider.rules.requiredCodeScanning.withRequiredCodeScanningTool

withRequiredCodeScanningTool(requiredCodeScanningTool)

"(Block Set, Min: 1) Actions code scanning tools that are required. Multiple can be defined. (see below for nested schema)\nTools that must provide code scanning results for this rule to pass."

fn spec.initProvider.rules.requiredCodeScanning.withRequiredCodeScanningToolMixin

withRequiredCodeScanningToolMixin(requiredCodeScanningTool)

"(Block Set, Min: 1) Actions code scanning tools that are required. Multiple can be defined. (see below for nested schema)\nTools that must provide code scanning results for this rule to pass."

Note: This function appends passed data to existing values

obj spec.initProvider.rules.requiredCodeScanning.requiredCodeScanningTool

"(Block Set, Min: 1) Actions code scanning tools that are required. Multiple can be defined. (see below for nested schema)\nTools that must provide code scanning results for this rule to pass."

fn spec.initProvider.rules.requiredCodeScanning.requiredCodeScanningTool.withAlertsThreshold

withAlertsThreshold(alertsThreshold)

"(String) The severity level at which code scanning results that raise alerts block a reference update. Can be one of: none, errors, errors_and_warnings, all.\nThe severity level at which code scanning results that raise alerts block a reference update. Can be one of: none, errors, errors_and_warnings, all."

fn spec.initProvider.rules.requiredCodeScanning.requiredCodeScanningTool.withSecurityAlertsThreshold

withSecurityAlertsThreshold(securityAlertsThreshold)

"(String) The severity level at which code scanning results that raise security alerts block a reference update. Can be one of: none, critical, high_or_higher, medium_or_higher, all.\nThe severity level at which code scanning results that raise security alerts block a reference update. Can be one of: none, critical, high_or_higher, medium_or_higher, all."

fn spec.initProvider.rules.requiredCodeScanning.requiredCodeScanningTool.withTool

withTool(tool)

"(String) The name of a code scanning tool.\nThe name of a code scanning tool"

obj spec.initProvider.rules.requiredDeployments

"(Block List, Max: 1) Choose which environments must be successfully deployed to before branches can be merged into a branch that matches this rule. (see below for nested schema)\nChoose which environments must be successfully deployed to before branches can be merged into a branch that matches this rule."

fn spec.initProvider.rules.requiredDeployments.withRequiredDeploymentEnvironments

withRequiredDeploymentEnvironments(requiredDeploymentEnvironments)

"(List of String) The environments that must be successfully deployed to before branches can be merged.\nThe environments that must be successfully deployed to before branches can be merged."

fn spec.initProvider.rules.requiredDeployments.withRequiredDeploymentEnvironmentsMixin

withRequiredDeploymentEnvironmentsMixin(requiredDeploymentEnvironments)

"(List of String) The environments that must be successfully deployed to before branches can be merged.\nThe environments that must be successfully deployed to before branches can be merged."

Note: This function appends passed data to existing values

obj spec.initProvider.rules.requiredStatusChecks

"(Block List, Max: 1) 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. (see below for nested schema)\nChoose 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."

fn spec.initProvider.rules.requiredStatusChecks.withDoNotEnforceOnCreate

withDoNotEnforceOnCreate(doNotEnforceOnCreate)

"(Boolean) Allow repositories and branches to be created if a check would otherwise prohibit it. Defaults to false.\nAllow repositories and branches to be created if a check would otherwise prohibit it."

fn spec.initProvider.rules.requiredStatusChecks.withRequiredCheck

withRequiredCheck(requiredCheck)

"(Block Set, Min: 1) Status checks that are required. Several can be defined. (see below for nested schema)\nStatus checks that are required. Several can be defined."

fn spec.initProvider.rules.requiredStatusChecks.withRequiredCheckMixin

withRequiredCheckMixin(requiredCheck)

"(Block Set, Min: 1) Status checks that are required. Several can be defined. (see below for nested schema)\nStatus checks that are required. Several can be defined."

Note: This function appends passed data to existing values

fn spec.initProvider.rules.requiredStatusChecks.withStrictRequiredStatusChecksPolicy

withStrictRequiredStatusChecksPolicy(strictRequiredStatusChecksPolicy)

"(Boolean) Whether pull requests targeting a matching branch must be tested with the latest code. This setting will not take effect unless at least one status check is enabled. Defaults to false.\nWhether pull requests targeting a matching branch must be tested with the latest code. This setting will not take effect unless at least one status check is enabled. Defaults to false."

obj spec.initProvider.rules.requiredStatusChecks.requiredCheck

"(Block Set, Min: 1) Status checks that are required. Several can be defined. (see below for nested schema)\nStatus checks that are required. Several can be defined."

fn spec.initProvider.rules.requiredStatusChecks.requiredCheck.withContext

withContext(context)

"(String) The status check context name that must be present on the commit.\nThe status check context name that must be present on the commit."

fn spec.initProvider.rules.requiredStatusChecks.requiredCheck.withIntegrationId

withIntegrationId(integrationId)

"(Number) The optional integration ID that this status check must originate from. It's a GitHub App ID, which can be obtained by following instructions from the Get an App API docs.\nThe optional integration ID that this status check must originate from."

obj spec.initProvider.rules.tagNamePattern

"(Block List, Max: 1) 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 applied to rulesets with target tag. (see below for nested schema)\nParameters 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."

fn spec.initProvider.rules.tagNamePattern.withName

withName(name)

"(String) How this rule will appear to users.\nHow this rule will appear to users."

fn spec.initProvider.rules.tagNamePattern.withNegate

withNegate(negate)

"(Boolean) If true, the rule will fail if the pattern matches.\nIf true, the rule will fail if the pattern matches."

fn spec.initProvider.rules.tagNamePattern.withOperator

withOperator(operator)

"(String) The operator to use for matching. Can be one of: starts_with, ends_with, contains, regex.\nThe operator to use for matching. Can be one of: starts_with, ends_with, contains, regex."

fn spec.initProvider.rules.tagNamePattern.withPattern

withPattern(pattern)

"(String) The pattern to match with.\nThe pattern to match with."

obj spec.providerConfigRef

"ProviderConfigReference specifies how the provider that will be used to\ncreate, observe, update, and delete this managed resource should be\nconfigured."

fn spec.providerConfigRef.withKind

withKind(kind)

"Kind of the referenced object."

fn spec.providerConfigRef.withName

withName(name)

"Name of the referenced object."

obj spec.writeConnectionSecretToRef

"WriteConnectionSecretToReference specifies the namespace and name of a\nSecret to which any connection details for this managed resource should\nbe written. Connection details frequently include the endpoint, username,\nand password required to connect to the managed resource."

fn spec.writeConnectionSecretToRef.withName

withName(name)

"Name of the secret."