|
| 1 | +# Pull-Request Label Guide |
| 2 | + |
| 3 | +> **Purpose** |
| 4 | +> Quick reference for **when** and **why** to apply the workflow-blocking labels used in MSAL repositories. |
| 5 | +
|
| 6 | +--- |
| 7 | + |
| 8 | +## 🚫 `do not merge` |
| 9 | + |
| 10 | +| What it means | When to apply | Who removes it | |
| 11 | +|---------------|---------------|----------------| |
| 12 | +| **Prod-validation hold** – the PR **has passed pre-prod** checks and CI but still needs a final **smoke test in PROD** (or a scheduled production deployment window). | **Examples**<br>• Awaiting the next prod flight / ring deployment.<br>• Holding merge until live-site sanity tests succeed.<br>• Release manager requests a coordinated go-live. | **Author** or a **maintainer** after the prod test passes and CI is green. | |
| 13 | + |
| 14 | +> **Tip:** Review feedback is welcome while this label is on, but **do not press “Merge.”** |
| 15 | +
|
| 16 | +--- |
| 17 | + |
| 18 | +## ⛔ `blocked` |
| 19 | + |
| 20 | +| What it means | When to apply | Who removes it | |
| 21 | +|---------------|---------------|----------------| |
| 22 | +| **Pre-prod failure / external blocker** – the PR **cannot progress** because something discovered in pre-prod (or earlier) must be fixed or become available **before** prod validation can even start. | **Examples**<br>• Bugs surfaced in pre-prod that need code changes.<br>• Missing or mis-configured test environment.<br>• External dependency (partner library, service rollout, legal sign-off) not ready.<br>• Perf or security review uncovered issues. | **Author** or a **maintainer** once all blockers are resolved **and** CI is green. | |
| 23 | + |
| 24 | +> **Heads-up:** Feel free to review the code, but **merging is off-limits** until this label is removed. |
| 25 | +
|
| 26 | +--- |
| 27 | + |
| 28 | +### Quick decision matrix |
| 29 | + |
| 30 | +| Scenario | Label to apply | |
| 31 | +|----------|----------------| |
| 32 | +| All tests green in pre-prod; waiting for prod smoke test ✔️ | `do not merge` | |
| 33 | +| Bugs reproduced in pre-prod; fix pending 🐞 | `blocked` | |
| 34 | +| Service endpoint not rolled out yet ⏳ | `blocked` | |
| 35 | +| Holding until next week’s coordinated release window 📆 | `do not merge` | |
| 36 | + |
| 37 | +--- |
| 38 | + |
| 39 | +### Steps to remove a label |
| 40 | + |
| 41 | +1. **Verify** CI is green. |
| 42 | +2. **Confirm** either |
| 43 | + * prod smoke test succeeded (`do not merge`), **or** |
| 44 | + * blocking issue is resolved (`blocked`). |
| 45 | +3. **Remove** the label and proceed with merge. |
0 commit comments