Skip to content

Commit b68d2bb

Browse files
docs(readme): document special branch patterns for workflow testing
Added new section explaining branch patterns allowed to merge to main: - dev: Production releases - test/*: Workflow validation and testing - release/*: Emergency hotfix releases - dependabot/*: Automated dependency updates Includes examples and use cases for each pattern. This documents the workflow changes from commit ab24a17. 🤖 Generated with [Claude Code](https://claude.com/claude-code) Co-Authored-By: Claude <noreply@anthropic.com>
1 parent 6d58bd5 commit b68d2bb

File tree

1 file changed

+28
-0
lines changed

1 file changed

+28
-0
lines changed

README.md

Lines changed: 28 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -190,6 +190,34 @@ The blueprint supports all three strategies out of the box. Choose during setup.
190190

191191
---
192192

193+
## 🔀 Special Branch Patterns
194+
195+
The `Release to Main` workflow allows specific branch patterns to merge directly to `main`:
196+
197+
| Pattern | Purpose | Use Case |
198+
|---------|---------|----------|
199+
| `dev` | Production releases | Standard release flow (dev → main) |
200+
| `test/*` | Workflow validation | Testing CI/CD changes (e.g., test/workflow-validation) |
201+
| `release/*` | Hotfix releases | Emergency fixes bypassing dev (e.g., release/1.0.1) |
202+
| `dependabot/*` | Dependency updates | Automated dependency PRs |
203+
204+
**Example:**
205+
```bash
206+
# Test workflow changes
207+
git checkout -b test/new-ci-feature
208+
git push origin test/new-ci-feature
209+
# PR to main will run all release gates
210+
211+
# Emergency hotfix
212+
git checkout -b release/1.0.1-security-patch
213+
git push origin release/1.0.1-security-patch
214+
# PR to main with fast-track release gates
215+
```
216+
217+
All other branches must follow the standard flow (feature/* → dev → main).
218+
219+
---
220+
193221
## 🔒 Security & Safety
194222

195223
Built-in protections ensure safe, reliable automation:

0 commit comments

Comments
 (0)