Configuration reference

Every key smartcloud accepts in .github/smartcloud.yml, generated from the JSON Schema.

This page is generated from schema/smartcloud.schema.json, which is generated from the Effect Schema in packages/config. The guides explain what each section does; this page lists every key.

Top level

Declarative repository automation: labels, conventions and policy.

Key	Type	Required	Notes
$schema	string	no
version	2	yes
extends	list of ExtendsEntry	no
telemetry	boolean	no	Set to false to stop smartcloud sending anonymous telemetry (hashed usage events, logs, traces, metrics and errors) to PostHog. On by default; turning it off is discouraged, because telemetry is how problems are found and fixed. The telemetry page of the documentation lists what is and is not collected.
labels	map of RuleId to Label	no
labelSync	object	no
labelSync.prune	boolean	no
labelling	map of RuleId to LabelRule	no
sizeLabels	SizeLabels	no
conventions	Conventions	no
roles	Roles	no
links	Links	no
commits	Commits	no
disclosure	Disclosure	no
reviews	Reviews	no
required	Required	no
freeze	Freeze	no
branches	Branches	no
codeowners	CodeOwners	no
stale	Stale	no
lock	Lock	no
backport	Backport	no
autoMerge	AutoMerge	no
settings	Settings	no
sync	Sync	no
notifications	Notifications	no
commands	Commands	no

Other keys are an error.

Types

ExtendsEntry

A preset to extend, as owner/repo/path@ref. The ref is optional. Pattern: ^(?!\.\.?\/)([A-Za-z0-9_.-]+)\/(?!\.\.?\/)([A-Za-z0-9_.-]+)\/((?!\.\.?(?:\/|@|$))[^/@]+(?:\/(?!\.\.?(?:\/|@|$))[^/@]+)*)(?:@([^@\s]+))?$.

Type: string.

Label

Key	Type	Required	Notes
name	string	yes
color	Color	yes
description	string	no
aliases	list of string	no

Other keys are an error.

Color

Six hex digits, for example 0E8A16, with or without a leading #. An unquoted all-digit colour such as 000123 is read as a number and padded back to six digits.

Type: any of string, integer.

RuleId

A label or rule key. Pattern: ^\S[\s\S]*\S$|^\S$|^$. At least 1 character(s).

Type: string.

LabelRule

Key	Type	Required	Notes
label	RuleId	yes
on	Subjects	no
when	ConditionGroup	yes

Other keys are an error.

Subjects

The subjects a rule applies to. Omitted means pull requests and issues.

Type: list of one of pullRequest, issue.

ConditionGroup

Key	Type	Required	Notes
requires	NonNegativeInt	no
condition	list of Condition	yes

Other keys are an error.

NonNegativeInt

Minimum: 0.

Type: integer.

Condition

Type: any of titleMatches, descriptionMatches, creatorMatches, branchMatches, baseBranchMatches, authorAssociation, hasAssignee, assigneeMatches, hasMilestone, milestoneMatches, linksIssue, isOpen, isLocked, isDraft, pendingReview, requestedChanges, reviewerMatches, commitsSignedOff, commitsVerified, hasConflict, checksPass, checkStatus, hasLabel, isStale, isAbandoned, filesMatch, codeownersTouched, changesSize, lockfileChanged, fileCount, binaryFilesAdded, isApproved, commitMessagesMatch, hasTrailer, commentMatches, reactionCount, createdBefore, timeWindow, dependencyUpdateType, and](#and), [or, not](#not), [only.

Pattern

Type: string.

Instant

An ISO 8601 date (2026-01-31, midnight UTC) or date and time with an offset (2026-01-31T09:00:00Z). Pattern: ^\d{4}-\d{2}-\d{2}(?:T\d{2}:\d{2}(?::\d{2}(?:\.\d+)?)?(?:Z|[+-]\d{2}:\d{2}))?$.

Type: string.

Weekday

A day of the week: mon, tue, wed, thu, fri, sat or sun.

Type: one of mon, tue, wed, thu, fri, sat, sun.

TimeZone

An IANA time zone name, such as Europe/London, or UTC.

Type: string.

UpdateType

A version update: patch, minor or major.

Type: one of patch, minor, major.

NonEmptyTrimmedString

a non empty string Pattern: ^\S[\s\S]*\S$|^\S$|^$. At least 1 character(s).

Type: string.

SizeLabels

Built-in Size: XS to Size: XL labels, applied to pull requests by lines added plus deleted. Thresholds are the first line count of each size.

Key	Type	Required	Notes
thresholds	object	no	The first line count of each size above XS. Sizes left out keep their defaults; the thresholds must rise from s to xl.
thresholds.s	Int	no	The fewest lines added plus deleted that make a pull request Size: S. Defaults to 10.
thresholds.m	Int	no	The fewest lines added plus deleted that make a pull request Size: M. Defaults to 100.
thresholds.l	Int	no	The fewest lines added plus deleted that make a pull request Size: L. Defaults to 500.
thresholds.xl	Int	no	The fewest lines added plus deleted that make a pull request Size: XL. Defaults to 1000.

Other keys are an error.

Int

Type: integer.

Conventions

Key	Type	Required	Notes
comment	object	no
comment.header	string	no
comment.footer	string	no
rules	map of RuleId to ConventionRule	no

Other keys are an error.

ConventionRule

Key	Type	Required	Notes
on	Subjects	no
level	one of error, warning	no
message	string	no
preset	one of conventionalCommits, semanticTitle, gitmojis, semanticEmoji	no
contexts	list of string	no
when	ConditionGroup	no

Other keys are an error.

Roles

Key	Type	Required	Notes
maintainers	list of string	no
trustedBots	list of string	no

Other keys are an error.

Links

Key	Type	Required	Notes
policyBase	string	no

Other keys are an error.

Commits

Key	Type	Required	Notes
dco	boolean	no
aiAttribution	boolean	no
assistedBy	boolean	no
aiIdentities	object	no
aiIdentities.emails	list of string	no
aiIdentities.names	list of string	no
maintainerLevel	Level	no

Other keys are an error.

Level

Type: one of error, warning.

Disclosure

Key	Type	Required	Notes
fields	object	no
fields.level	string	no
fields.tools	string	no
fields.accountable	string	no
fields.review	string	no
requireDraft	boolean	no
maintainerLevel	Level	no

Other keys are an error.

Reviews

Key	Type	Required	Notes
gate	object	no
gate.outside	NonNegativeInt	no
gate.maintainer	NonNegativeInt	no
requestApprovals	map of string to RequestApproval	no
automaticApprove	map of string to AutomaticApprove	no

Other keys are an error.

RequestApproval

Key	Type	Required	Notes
reviewers	list of string	yes
strategy	one of round-robin, load-balanced, codeowners	no
count	Int	no	a positive number
when	ConditionGroup	yes

Other keys are an error.

AutomaticApprove

Key	Type	Required	Notes
when	ConditionGroup	yes
message	string	no

Other keys are an error.

Required

One aggregate check that passes only when every other check on the pull request has passed, so a ruleset requires that one check instead of a list of names.

Key	Type	Required	Notes
ignore	list of Pattern	no	Checks that do not count towards the aggregate, as patterns matched against each check run name or status context, for example ^codecov/.
expect	list of Pattern	no	Checks that must appear on the head commit and pass, as patterns matched against each check run name or status context, for example ^check$. One that has not appeared by the timeout fails the aggregate, so a deleted or renamed CI job cannot pass unnoticed.
timeout	Int	no	Minutes to wait for the other checks to finish before failing, from 1 to 360 (the longest an Actions job may run). Defaults to 60. Minimum: 1.

Other keys are an error.

Freeze

A merge freeze, manual or scheduled: while one is in effect the freeze check fails on open pull requests and merge queue entries fail.

Key	Type	Required	Notes
active	boolean	no	Freeze merges now, until this is set back to false. Off by default.
reason	string	no	Why merges are frozen while active is true.
windows	map of string to FreezeWindow	no	Scheduled freezes, by key: dated (start and end) or recurring (from and to, every day or every week).
exempt	object	no
exempt.labels	list of string	no	Pull requests with any of these labels may merge during a freeze.

Other keys are an error.

FreezeWindow

Type: any of FreezeDates, FreezeRecurring.

FreezeDates

Key	Type	Required	Notes
start	string	yes	a string matching the pattern ^\d{4}-\d{2}-\d{2}T\d{2}:\d{2}(?::\d{2}(?:.\d+)?)?(?:Z|[+-]\d{2}:\d{2})$Pattern: `^\d{4}-\d{2}-\d{2}T\d{2}:\d{2}(?::\d{2}(?:\.\d+)?)?(?:Z\|[+-]\d{2}:\d{2})$`.
end	string	yes	a string matching the pattern ^\d{4}-\d{2}-\d{2}T\d{2}:\d{2}(?::\d{2}(?:.\d+)?)?(?:Z|[+-]\d{2}:\d{2})$Pattern: `^\d{4}-\d{2}-\d{2}T\d{2}:\d{2}(?::\d{2}(?:\.\d+)?)?(?:Z\|[+-]\d{2}:\d{2})$`.
reason	string	no	Why merges are frozen, shown on the check and in the report.

Other keys are an error.

FreezeRecurring

Key	Type	Required	Notes
from	string	yes	HH:MM for a time every day, or a three-letter day and HH:MM, such as Fri 16:00, for a time every week. Pattern: ^(?:(Sun|Mon|Tue|Wed|Thu|Fri|Sat) )?([01]\d|2[0-3]):([0-5]\d)$.
to	string	yes	HH:MM for a time every day, or a three-letter day and HH:MM, such as Fri 16:00, for a time every week. Pattern: ^(?:(Sun|Mon|Tue|Wed|Thu|Fri|Sat) )?([01]\d|2[0-3]):([0-5]\d)$.
timezone	string	no
reason	string	no	Why merges are frozen, shown on the check and in the report.

Other keys are an error.

Branches

A branch naming policy: the head branch of every pull request must match one of the accepted names.

Key	Type	Required	Notes
names	map of string to BranchName	no	The accepted forms of branch name, by key, so presets and repositories merge them. A head branch passes when it matches any of them.
level	one of error, warning	no	error fails the check; warning only reports. Defaults to error.
message	string	no	Shown instead of the list of accepted names.
exempt	object	no
exempt.branches	list of Pattern	no	Head branches matching any of these patterns are not checked, such as ^dependabot/.
exempt.authors	list of string	no	Pull requests opened by these logins are not checked, such as renovate[bot].

Other keys are an error.

BranchName

One accepted form of branch name: a preset, a pattern, or both, when the name must meet both.

Key	Type	Required	Notes
preset	one of prefixed, issueKey	no	prefixed: <prefix>/<description>, such as ann/fix-typo or feat/labels. issueKey: an issue key such as SMC-12 anywhere in the name, between separators.
prefixes	list of NonEmptyTrimmedString	no	The prefixes the prefixed preset accepts, such as feat and fix, or the names of people. Any prefix when left out.
keys	list of string	no	The issue tracker keys the issueKey preset accepts, such as SMC. Any key when left out.
pattern	Pattern	no

Other keys are an error.

CodeOwners

CODEOWNERS: check the file on pull requests that change it, and generate a block of it from rules in the config.

Key	Type	Required	Notes
path	one of .github/CODEOWNERS, CODEOWNERS, docs/CODEOWNERS	no	Where the file lives, one of the locations GitHub reads. By default, the first that exists, or .github/CODEOWNERS.
rules	map of any to CodeOwnersRule	no	Rules to generate, by key, so presets and repositories merge them. They are written in order, and the last matching rule wins. A key must not be a whole number such as 2, which would be moved first.
check	boolean	no	Check pull requests that change CODEOWNERS. On by default.
level	one of error, warning	no	error fails the check; warning only reports. Defaults to error.
branch	Trimmed	no	The branch generated changes are proposed from. Defaults to smartcloud/codeowners. At least 1 character(s).

Other keys are an error.

CodeOwnersRule

Paths and their owners, written to the generated block of CODEOWNERS.

Key	Type	Required	Notes
paths	list of CodeOwnersPath	yes	The path patterns these owners own, each written as its own CODEOWNERS line. At least 1 item(s).
owners	list of CodeOwner	yes	The owners of the paths. An empty list leaves them without an owner, overriding an earlier rule.
comment	string	no	A comment written above the lines, such as Documentation.

Other keys are an error.

CodeOwnersPath

A path pattern such as .md, /docs/ or apps/**/.ts. GitHub does not support ! or [ ] in CODEOWNERS patterns; write a space as \ followed by a space, as in docs/My\ Files/. Pattern: ^(?:\\ |\\[^\s[\]#]|[^!#\s[\]\\])(?:\\ |\\[^\s[\]]|[^\s[\]\\])*$.

Type: string.

CodeOwner

A user as @login, a team as @org/team, or an email address. Pattern: ^(@[A-Za-z0-9](?:[A-Za-z0-9-]*[A-Za-z0-9])?(?:\/[A-Za-z0-9][A-Za-z0-9._-]*)?|[^@\s]+@[^@\s]+\.[^@\s]+)$.

Type: string.

Trimmed

trimmed

a string with no leading or trailing whitespace Pattern: ^\S[\s\S]*\S$|^\S$|^$.

Type: string.

Stale

Key	Type	Required	Notes
on	list of one of pullRequest, issue	no
staleAfterDays	NonNegative	yes
staleLabel	string	yes
staleComment	string	no
abandonedAfterDays	NonNegative	no
abandonedLabel	string	no
abandonedComment	string	no
close	boolean	no
exempt	object	no
exempt.labels	list of string	no
exempt.when	ConditionGroup	no

Other keys are an error.

NonNegative

Minimum: 0.

Type: number.

Lock

Key	Type	Required	Notes
on	list of one of pullRequest, issue	no
afterDays	NonNegative	yes
reason	LockReason	no
comment	string	no
label	string	no
exempt	object	no
exempt.labels	list of string	no

Other keys are an error.

LockReason

Type: one of resolved, off-topic, too heated, spam.

Backport

Key	Type	Required	Notes
prefix	BackportPrefix	no
labels	list of string	no

Other keys are an error.

BackportPrefix

Backport label prefix

The start of a backport label, such as backport ; the rest of the label is the branch. At least 1 character(s).

Type: string.

AutoMerge

Turns on GitHub auto-merge for a pull request when one of the rules passes, such as a Dependabot patch update.

Key	Type	Required	Notes
rules	map of string to AutoMergeRule	no	The auto-merge rules, by key, so presets and repositories merge them. The first rule whose conditions pass, in order, turns auto-merge on with its method.
disableWhenUnmatched	boolean	no	Turn auto-merge off again when no rule passes any more, but only where smartcloud turned it on and nobody has changed it since. Off by default.

Other keys are an error.

AutoMergeRule

When the conditions pass on an open pull request, smartcloud turns on GitHub auto-merge with the method.

Key	Type	Required	Notes
when	ConditionGroup	yes
method	one of merge, squash, rebase	no	How GitHub merges the pull request once auto-merge is on: merge, squash or rebase. Squash by default.

Other keys are an error.

Settings

Key	Type	Required	Notes
merging	object	no
merging.mergeCommit	boolean	no
merging.squash	boolean	no
merging.rebase	boolean	no
merging.autoMerge	boolean	no
merging.updateBranch	boolean	no
merging.deleteBranchOnMerge	boolean	no
merging.webCommitSignoff	boolean	no
merging.squashTitle	one of PR_TITLE, COMMIT_OR_PR_TITLE	no
merging.squashMessage	one of COMMIT_MESSAGES, PR_BODY, BLANK	no
features	object	no
features.wiki	boolean	no
features.discussions	boolean	no
features.sponsorships	boolean	no
security	object	no
security.immutableReleases	boolean	no
security.privateVulnerabilityReporting	boolean	no
security.dependabotAlerts	boolean	no
security.dependabotSecurityUpdates	boolean	no
security.codeScanning	one of default, extended, off	no
security.secretScanning	boolean	no
ruleset	object	no
ruleset.name	string	no
ruleset.linearHistory	boolean	no
ruleset.blockDeletion	boolean	no
ruleset.blockForcePush	boolean	no
ruleset.mergeQueue	object	no
ruleset.mergeQueue.method	one of squash, rebase, merge	no
ruleset.mergeQueue.grouping	one of allGreen, headGreen	no
ruleset.mergeQueue.checkTimeoutMinutes	Int	no	a number between 1 and 360 Minimum: 1.
ruleset.mergeQueue.maxEntriesToBuild	Int	no	a number between 0 and 100 Minimum: 0.
ruleset.mergeQueue.minEntriesToMerge	Int	no	a number between 0 and 100 Minimum: 0.
ruleset.mergeQueue.maxEntriesToMerge	Int	no	a number between 0 and 100 Minimum: 0.
ruleset.mergeQueue.minEntriesToMergeWaitMinutes	Int	no	a number between 0 and 360 Minimum: 0.
ruleset.requiredDeployments	list of string	no
ruleset.signedCommits	boolean	no
ruleset.pullRequest	object	no
ruleset.pullRequest.requiredApprovals	NonNegativeInt	no	a number less than or equal to 10
ruleset.pullRequest.dismissStaleReviews	boolean	no
ruleset.pullRequest.codeOwnerReview	boolean	no
ruleset.pullRequest.lastPushApproval	boolean	no
ruleset.pullRequest.conversationResolution	boolean	no
ruleset.pullRequest.extraApprovalForUnattributedCopilot	boolean	no
ruleset.pullRequest.mergeMethods	list of one of squash, rebase, merge	no	At least 1 item(s).
ruleset.statusChecks	object	no
ruleset.statusChecks.checks	map of string to boolean	no
ruleset.statusChecks.strict	boolean	no
ruleset.statusChecks.skipOnCreation	boolean	no
ruleset.requiredChecks	list of string	no
ruleset.codeScanningGate	boolean	no
ruleset.codeScanning	map of string to object	no
ruleset.codeQuality	one of errors, warnings, notes, all	no
ruleset.codeCoverage	object	no
ruleset.codeCoverage.enabled	boolean	no
ruleset.codeCoverage.minimum	number	no	a number between 0 and 100 Minimum: 0.
ruleset.codeCoverage.maxDrop	number	no	a number between 0 and 100 Minimum: 0.
ruleset.secretScanningAlerts	list of string	no	At least 1 item(s).
ruleset.copilotReview	boolean	no
ruleset.adminBypass	boolean	no
environments	object	no
environments.projectType	one of saas, desktop, library, none	no
environments.names	list of string	no
actions	object	no
actions.enabled	boolean	no
actions.allowedActions	one of all, local_only, selected	no
actions.shaPinningRequired	boolean	no
actions.selectedActions	object	no
actions.selectedActions.githubOwned	boolean	no
actions.selectedActions.verifiedCreators	boolean	no
actions.selectedActions.patterns	list of string	no
actions.workflowPermissions	one of read, write	no
actions.createPullRequests	boolean	no
actions.accessLevel	one of none, user, organization, enterprise	no
collaborators	map of string to one of read, triage, write, maintain, admin, none	no	Keys match ^[A-Za-z0-9](?:[A-Za-z0-9-]*[A-Za-z0-9])?$.
teams	map of string to one of read, triage, write, maintain, admin	no	Keys match ^[a-z0-9][a-z0-9_-]*$.
webhooks	map of string to object	no
pages	object	no
pages.enabled	boolean	no
pages.buildType	one of workflow, legacy	no
pages.branch	string	no
pages.path	one of /, /docs	no
pages.cname	string	no
pages.httpsEnforced	boolean	no
variables	map of string to string	no	Keys match ^(?![Gg][Ii][Tt][Hh][Uu][Bb]_)[A-Za-z_][A-Za-z0-9_]*$.

Other keys are an error.

Sync

Key	Type	Required	Notes
source	string	yes
values	map of string to string	no	Keys match ^[A-Z][A-Z0-9_]*$.
exclude	list of string	no
branch	string	no
check	boolean	no
maintainerLevel	Level	no

Other keys are an error.

Notifications

Key	Type	Required	Notes
channels	map of NonEmptyTrimmedString to NotificationChannel	yes

Other keys are an error.

NotificationChannel

Type: any of SlackChannel, DiscordChannel, LinearChannel.

SlackChannel

Key	Type	Required	Notes
type	slack	yes
secret	SecretName	no
on	list of one of failures, stale	no
level	Level	no

Other keys are an error.

SecretName

The name of the environment variable holding the secret. Pattern: ^[A-Za-z_][A-Za-z0-9_]*$.

Type: string.

DiscordChannel

Key	Type	Required	Notes
type	discord	yes
secret	SecretName	no
on	list of one of failures, stale	no
level	Level	no
username	string	no

Other keys are an error.

LinearChannel

Key	Type	Required	Notes
type	linear	yes
secret	SecretName	no
on	list of one of failures, stale	no
level	Level	no
team	NonEmptyTrimmedString	yes
labels	list of string	no

Other keys are an error.

Commands

Key	Type	Required	Notes
overrides	object	no	Per-command changes to who may use it, by command name.
overrides.help	CommandPolicy	no
overrides.label	CommandPolicy	no
overrides.unlabel	CommandPolicy	no
overrides.assign	CommandPolicy	no
overrides.unassign	CommandPolicy	no
overrides.reviewer	CommandPolicy	no
overrides.unreviewer	CommandPolicy	no
overrides.retitle	CommandPolicy	no
overrides.close	CommandPolicy	no
overrides.reopen	CommandPolicy	no
overrides.lock	CommandPolicy	no
overrides.unlock	CommandPolicy	no
overrides.draft	CommandPolicy	no
overrides.ready	CommandPolicy	no
overrides.update	CommandPolicy	no
overrides.rebase	CommandPolicy	no
overrides.approve	CommandPolicy	no
overrides.merge	CommandPolicy	no
overrides.automerge	CommandPolicy	no
overrides.stale-snooze	CommandPolicy	no
overrides.backport	CommandPolicy	no
overrides.run	CommandPolicy	no
snoozeDays	Int	no	Days /stale-snooze keeps an item from being marked stale when no number is given; 30 by default. Minimum: 1.
mergeMethod	one of merge, squash, rebase	no	How /merge and /automerge merge when no method is given; squash by default.
backport	object	no
backport.labelPrefix	string	no	Labels that ask for a backport on merge are this prefix and the target branch; “backport ” by default. At least 1 character(s).
backport.branchPrefix	string	no	Backport branches start with this; “backport/” by default. At least 1 character(s).
reactions	boolean	no	React to each command comment with 👍 or 😕. On by default.

Other keys are an error.

CommandPolicy

Key	Type	Required	Notes
enabled	boolean	no	Set to false to ignore the command. On by default.
permission	one of read, triage, write, maintain, admin	no	The lowest repository role that may use the command. Each command has its own default.
author	boolean	no	Whether the issue’s or pull request’s author may use the command on their own item whatever their role. Each command has its own default.

Other keys are an error.

Conditions

Each condition is an object with a type naming it. See Conditions for how groups and combinators evaluate.

titleMatches

The title matches a pattern.

Key	Type	Required	Notes
type	titleMatches	yes
condition	Pattern	yes

Other keys are an error.

descriptionMatches

The description matches a pattern.

Key	Type	Required	Notes
type	descriptionMatches	yes
condition	Pattern	yes

Other keys are an error.

creatorMatches

The author’s login matches a pattern.

Key	Type	Required	Notes
type	creatorMatches	yes
condition	Pattern	yes

Other keys are an error.

branchMatches

The pull request’s head branch matches a pattern.

Key	Type	Required	Notes
type	branchMatches	yes
condition	Pattern	yes

Other keys are an error.

baseBranchMatches

The pull request’s base branch, the one it merges into, matches a pattern.

Key	Type	Required	Notes
type	baseBranchMatches	yes
condition	Pattern	yes

Other keys are an error.

authorAssociation

The author’s association with the repository is one of these, or the author is a bot when bot is listed.

Key	Type	Required	Notes
type	authorAssociation	yes
condition	list of one of owner, member, collaborator, contributor, firstTimeContributor, firstTimer, mannequin, none, bot	yes	The associations that pass; any one is enough. At least 1 item(s).

Other keys are an error.

hasAssignee

Someone is assigned, or nobody is when false.

Key	Type	Required	Notes
type	hasAssignee	yes
condition	boolean	yes

Other keys are an error.

assigneeMatches

An assignee’s login matches a pattern.

Key	Type	Required	Notes
type	assigneeMatches	yes
condition	Pattern	yes

Other keys are an error.

hasMilestone

The subject is in a milestone, or in none when false.

Key	Type	Required	Notes
type	hasMilestone	yes
condition	boolean	yes

Other keys are an error.

milestoneMatches

The title of the subject’s milestone matches a pattern.

Key	Type	Required	Notes
type	milestoneMatches	yes
condition	Pattern	yes

Other keys are an error.

linksIssue

The pull request closes an issue in its description, or carries a Linear key in its branch or title; links none when false.

Key	Type	Required	Notes
type	linksIssue	yes
condition	boolean	yes
keys	list of string	no	The Linear team keys that count; any key when omitted. At least 1 item(s).

Other keys are an error.

isOpen

The subject is open, or closed when false.

Key	Type	Required	Notes
type	isOpen	yes
condition	boolean	yes

Other keys are an error.

isLocked

The conversation is locked, or unlocked when false.

Key	Type	Required	Notes
type	isLocked	yes
condition	boolean	yes

Other keys are an error.

isDraft

The pull request is a draft, or ready when false.

Key	Type	Required	Notes
type	isDraft	yes
condition	boolean	yes

Other keys are an error.

pendingReview

Requested reviewers have not reviewed yet.

Key	Type	Required	Notes
type	pendingReview	yes
condition	boolean	yes

Other keys are an error.

requestedChanges

A reviewer’s latest review requests changes.

Key	Type	Required	Notes
type	requestedChanges	yes
condition	boolean	yes

Other keys are an error.

reviewerMatches

A requested reviewer’s login or team slug, or a reviewer’s login, matches a pattern.

Key	Type	Required	Notes
type	reviewerMatches	yes
condition	Pattern	yes

Other keys are an error.

commitsSignedOff

Every non-merge commit has a Signed-off-by trailer matching its author email.

Key	Type	Required	Notes
type	commitsSignedOff	yes
condition	boolean	yes

Other keys are an error.

commitsVerified

Every commit has a GPG, SSH or S/MIME signature that GitHub verified.

Key	Type	Required	Notes
type	commitsVerified	yes
condition	boolean	yes

Other keys are an error.

hasConflict

The pull request conflicts with its base branch, or does not when false. Unknown mergeability counts as not conflicting.

Key	Type	Required	Notes
type	hasConflict	yes
condition	boolean	yes

Other keys are an error.

checksPass

Every named check succeeded, or at least one has not when false. A check that has not reported yet has not succeeded.

Key	Type	Required	Notes
type	checksPass	yes
checks	list of string	yes	Check run names or commit status contexts, matched exactly. At least 1 item(s).
condition	boolean	yes

Other keys are an error.

checkStatus

The named check is in this state. A check that has not reported yet is pending.

Key	Type	Required	Notes
type	checkStatus	yes
check	string	yes	A check run name or commit status context, matched exactly. At least 1 character(s).
condition	one of success, failure, pending	yes	success, failure or pending; a check that has not reported yet is pending.

Other keys are an error.

hasLabel

The subject has the label, or lacks it when false.

Key	Type	Required	Notes
type	hasLabel	yes
label	string	yes
condition	boolean	yes

Other keys are an error.

isStale

No activity for at least this many days.

Key	Type	Required	Notes
type	isStale	yes
condition	number	yes	A number of days. Minimum: 0.

Other keys are an error.

isAbandoned

Carries the stale label and has had no activity for at least this many days.

Key	Type	Required	Notes
type	isAbandoned	yes
condition	number	yes	A number of days. Minimum: 0.
label	string	yes

Other keys are an error.

filesMatch

At least one changed file matches a glob.

Key	Type	Required	Notes
type	filesMatch	yes
condition	string	yes

Other keys are an error.

codeownersTouched

At least one changed file is owned by this owner in CODEOWNERS.

Key	Type	Required	Notes
type	codeownersTouched	yes
condition	string	yes	A CODEOWNERS owner: @org/team, @user or an email. Pattern: ^(?:@[A-Za-z0-9][\w.-]*(?:\/[\w.-]+)?|[^\s@]+@[^\s@]+)$.

Other keys are an error.

changesSize

Lines added plus deleted are at least min and below max.

Key	Type	Required	Notes
type	changesSize	yes
min	NonNegativeInt	yes
max	NonNegativeInt	no

Other keys are an error.

lockfileChanged

A dependency lockfile changed, or none did when false.

Key	Type	Required	Notes
type	lockfileChanged	yes
condition	boolean	yes

Other keys are an error.

fileCount

The number of changed files is at least min and below max.

Key	Type	Required	Notes
type	fileCount	yes
min	NonNegativeInt	yes
max	NonNegativeInt	no

Other keys are an error.

binaryFilesAdded

The pull request adds a binary file, or none when false.

Key	Type	Required	Notes
type	binaryFilesAdded	yes
condition	boolean	yes

Other keys are an error.

isApproved

No reviewer is requesting changes, at least this many approved, and none are pending unless allowPending is set.

Key	Type	Required	Notes
type	isApproved	yes
condition	NonNegativeInt	yes
allowPending	boolean	no	Count approvals while other requested reviewers are still pending (default false).

Other keys are an error.

commitMessagesMatch

Commit messages match a pattern.

Key	Type	Required	Notes
type	commitMessagesMatch	yes
condition	Pattern	yes
scope	one of all, any	no	Whether every commit (all) or at least one commit (any) must match.

Other keys are an error.

hasTrailer

Commits carry the trailer, with a value matching the pattern when one is given.

Key	Type	Required	Notes
type	hasTrailer	yes
trailer	string	yes
condition	Pattern	no
scope	one of all, any	no	Whether every commit (all) or at least one commit (any) must match.

Other keys are an error.

commentMatches

At least one comment matches a pattern; comments by bots count only when bots is set.

Key	Type	Required	Notes
type	commentMatches	yes
condition	Pattern	yes
bots	boolean	no	Also match comments by bot accounts (default false).

Other keys are an error.

reactionCount

The number of reactions (of one kind, when reaction is set) is at least min and below max.

Key	Type	Required	Notes
type	reactionCount	yes
reaction	one of +1, -1, laugh, hooray, confused, heart, rocket, eyes	no	The reaction to count: +1, -1, laugh, hooray, confused, heart, rocket or eyes. Every reaction when omitted.
min	NonNegativeInt	yes
max	NonNegativeInt	no

Other keys are an error.

createdBefore

The subject was created at least this many days ago, or before this ISO 8601 date.

Key	Type	Required	Notes
type	createdBefore	yes
condition	any of number, Instant	yes

Other keys are an error.

timeWindow

Now is inside the weekly window of days and hours, or outside it when false.

Key	Type	Required	Notes
type	timeWindow	yes
condition	boolean	yes
days	list of Weekday	no	The days the window opens on; every day when omitted. At least 1 item(s).
from	string	no	When the window opens, as HH:MM (inclusive); midnight when omitted. Pattern: ^(?:[01]\d|2[0-3]):[0-5]\d$.
to	string	no	When the window closes, as HH:MM (exclusive); midnight when omitted. Pattern: ^(?:[01]\d|2[0-3]):[0-5]\d$.
timeZone	TimeZone	no

Other keys are an error.

dependencyUpdateType

A Dependabot or Renovate pull request’s largest version change is one of these: patch, minor or major.

Key	Type	Required	Notes
type	dependencyUpdateType	yes
condition	list of UpdateType	yes	The update types that pass; any one is enough. At least 1 item(s).
bots	list of NonEmptyTrimmedString	no	More logins that open dependency updates, such as a self-hosted Renovate app; dependabot[bot] and renovate[bot] always count. At least 1 item(s).

Other keys are an error.

$and

Every group passes.

Key	Type	Required	Notes
type	$and	yes
condition	list of ConditionGroup	yes

Other keys are an error.

$or

At least one group passes.

Key	Type	Required	Notes
type	$or	yes
condition	list of ConditionGroup	yes

Other keys are an error.

$not

The group fails.

Key	Type	Required	Notes
type	$not	yes
requires	NonNegativeInt	no
condition	any of ConditionGroup, a one-item list of ConditionGroup, list of Condition	yes

Other keys are an error.

$only

Exactly this many of the groups pass.

Key	Type	Required	Notes
type	$only	yes
requires	NonNegativeInt	yes
condition	list of ConditionGroup	yes

Other keys are an error.