Skip to content

Commit bc236f5

Browse files
myftijaTrigger.dev RepoOps
authored andcommitted
docs: document ignored paths for GitHub builds
The GitHub integration docs page now covers ignored paths: where to set the patterns, how they match, what a skipped build looks like on the commit, and how to build it anyway. Mono-RevId: 7c1b20a0a79396df0d340fbb56ca0cb40f4f5760
1 parent 53441fd commit bc236f5

1 file changed

Lines changed: 21 additions & 0 deletions

File tree

‎docs/github-integration.mdx‎

Lines changed: 21 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -72,6 +72,27 @@ The name of the preview branch matches the branch name of the pull request.
7272
Preview branch deployments require the preview environment to be enabled on your project. Learn more about [preview branches](/deployment/preview-branches).
7373
</Note>
7474

75+
## Ignored paths
76+
77+
Skip builds for pushes that only touch files your tasks do not depend on, such as docs or another app in a monorepo.
78+
79+
Open **Integrations** in your project settings and add the patterns in the git settings panel below the branch fields, one per line. A push builds unless every file changed by the pushed commits matches a pattern. A newly opened pull request compares every file it changes against its base branch in the same way. Some pushes build regardless of the patterns, such as force pushes or pushes that change 300 or more files. Use **Test a path** to check which pattern, if any, ignores a given file.
80+
81+
```text
82+
docs/**
83+
**/*.md
84+
apps/web/**
85+
.github/**
86+
```
87+
88+
Patterns are globs relative to the repository root and match like `paths-ignore` in GitHub Actions. `**` matches across folders and also matches dotfiles, so `**/*.md` ignores `.github/PULL_REQUEST_TEMPLATE.md`. Negation (`!`), braces (`{a,b}`), extglob groups like `+(...)` and `[!...]` are not supported; use `[^...]` to exclude characters. You can add up to 100 patterns of up to 256 characters each.
89+
90+
When a build is skipped, no deployment is created and the commit's Trigger.dev check is marked as skipped, with the matched patterns in its summary. Re-run that check from GitHub to build the commit anyway.
91+
92+
<Note>
93+
Projects connected to Vercel always build. See [production waits for your tasks](/vercel-integration#production-waits-for-your-tasks).
94+
</Note>
95+
7596
## Version skew protection
7697

7798
Every deployment the GitHub integration creates is tagged with the commit SHA it was built from. That is the deploy half of [version skew protection](/deployment/atomic-deployment) — you get it for free.

0 commit comments

Comments
 (0)