Skip to main content

Apply Requirements

The apply_requirements configuration allows for the specification of when an apply operation can be performed in an pull request that has not been merged.

Keys

KeyTypeDescription
checksobjectConfiguration for the apply requirement checks
create_pending_apply_checkboolCreate checks for applies immediately, default true
info

create_pending_apply_check creates a status check per dirspace that is marked as pending and it is not marked as complete until the apply has run for that dirspace. This option is to prevent a pull request from being merged before all applies have been executed.

However, if a dirspace has autoapply set to true, a check is not created for the dirspace. This is because autoapply means that the apply operation is performed after the pull request has been merged, so we do not want to prevent the pull request from being merged.

Checks

KeyTypeDescription
approvedobjectConfiguration for pull request approvals
merge_conflictsobjectConfiguration for merge conflicts
status_checksobjectConfiguration for status checks
info

The apply_requirements configuration is only evaluated for pull requests that are not merged.

Approved

Requires that the pull request has received a certain number of approvals.

KeyTypeDescription
enabledboolIf the check is enabled, default false
countboolNumber of approvals needed to pass, default 1

Merge Conflicts Keys

Requires that the pull request has no merge conflicts.

KeyTypeDescription
enabledboolIf the check is enabled, default true

Status Checks

Requires that all status checks associated with the pull request have passed.

KeyTypeDescription
enabledboolIf the check is enabled, default true
ignore_matchingstring arrayList of regex to match against names of checks to ignore

Default Configuration

apply_requirements:
checks:
approved:
enabled: false
count: 1
merge_conflicts:
enabled: true
status_checks:
enabled: true
ignore_matching: []
create_pending_apply_check: true