Skip to content

Commit b7fe25b

Browse files
simpsonwclaude
andcommitted
docs: add auto-pass-branch-prefix documentation
Add user-facing documentation for the new auto-pass feature to README.md, including usage examples and security warnings. Co-Authored-By: Claude Sonnet 4.5 <noreply@anthropic.com>
1 parent cb68304 commit b7fe25b

File tree

1 file changed

+23
-0
lines changed

1 file changed

+23
-0
lines changed

README.md

Lines changed: 23 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -34,4 +34,27 @@ This mode:
3434
- Fails immediately if any required check fails
3535
- Cannot be combined with a custom `check-run-regex` or `status-regex`
3636

37+
### Auto-pass for trusted branches
38+
39+
Skip all status checks for branches with a specific prefix:
40+
41+
```yaml
42+
- uses: etsy/combined-status-check@v1
43+
with:
44+
auto-pass-branch-prefix: "grimoire-"
45+
required-check-runs: |
46+
build
47+
test
48+
lint
49+
```
50+
51+
This mode:
52+
- Automatically passes when the branch name starts with the configured prefix (case-sensitive)
53+
- Bypasses all status check validation entirely
54+
- Useful for trusted automated branches that should always pass
55+
- Can be combined with any other mode (regex or required-check-runs)
56+
- Leave empty to disable (default behavior)
57+
58+
**⚠️ Security Note:** This feature completely skips all status checks. Only use it with trusted automated systems where you have full control over branch creation.
59+
3760
See [`action.yml`](./action.yml) for all available options.

0 commit comments

Comments
 (0)