When Framecheck runs

Skip selected pull requests before building Storybook.

Configure rules#

An owner or admin can configure Project settings → When Framecheck runs. Rules can match a pull request by author, branch, label, or draft status. Use the settings form's matcher and preview rather than assuming all fields accept regular expressions.

Typical uses include excluding dependency bots or draft pull requests. Keep the generated workflow's precheck step before dependency installation and the Storybook build to save CI work.

Understand a skip#

A matched pull request gets a neutral skipped check when the GitHub App can publish it. No Storybook is uploaded for that decision. A skipped check is not evidence that the stories were tested.

The rules apply to pull requests. Pushes to the default branch and manual runs still run. A precheck also validates credentials on those triggers.

Re-evaluate after a label or draft change#

The generated workflow listens for label and ready-for-review events as well as new commits. Preserve those events when customising the workflow so rule changes can take effect. Framecheck can report that a commit already has a result and needs no new upload.

Avoid missing baseline coverage#

Do not remove the default-branch workflow to save builds. Accepted default-branch runs are what maintain the baseline for future comparisons. Consider Smart Snapshots for reducing capture work on pull requests.