Skip to content
Closed
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
19 changes: 16 additions & 3 deletions .github/operations/MILESTONE_ALLOCATION_ANNOUNCEMENT.md
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
# 🎉 NEW FEATURE: Automatic Milestone Allocation Now Live!
# 🎉 NEW FEATURE: Automatic Milestone Allocation Now Live

**Announcement Date:** 2026-08-24
**Related Issue:** [#1765](https://github.com/lightspeedwp/.github/issues/1765)
Expand DownExpand Up@@ -28,6 +28,7 @@ We've deployed **automatic allocation of merged PRs and closed issues** to proje
### Example

You merge a PR with this in the description:

```
This PR fixes the critical auth bug.

Expand All@@ -36,6 +37,7 @@ Resolves #1886
```

**Result:**

- PR automatically allocated to v1.5.0 milestone
- Issue #1885 automatically allocated to v1.5.0 milestone
- Issue #1886 automatically allocated to v1.5.0 milestone
Expand All@@ -48,6 +50,7 @@ Resolves #1886
We've created comprehensive documentation to help you:

### [RUNBOOK.md](../../.github/projects/active/pr-issue-milestone-allocation-2026-08-11/RUNBOOK.md)

**Step-by-step operations guide** — How to use the script manually

- Quick Start (automatic operation explained)
Expand All@@ -59,6 +62,7 @@ We've created comprehensive documentation to help you:
- Best Practices

### [FAQ.md](../../.github/projects/active/pr-issue-milestone-allocation-2026-08-11/FAQ.md)

**52 Q&A pairs covering everything**

- General Questions (11)
Expand All@@ -72,6 +76,7 @@ We've created comprehensive documentation to help you:
- Integration & APIs (2)

### [QUICK-REFERENCE.md](../../.github/projects/active/pr-issue-milestone-allocation-2026-08-11/QUICK-REFERENCE.md)

**Quick command reference** — One-page cheat sheet

---
Expand DownExpand Up@@ -120,7 +125,7 @@ See [RUNBOOK.md](../../.github/projects/active/pr-issue-milestone-allocation-202

## 🎯 What You Need to Know

### For Most Users: Nothing!
### For Most Users: Nothing

✅ **The feature works automatically** — no setup needed
✅ **No action required** — just merge PRs normally
Expand All@@ -147,6 +152,7 @@ See [RUNBOOK.md](../../.github/projects/active/pr-issue-milestone-allocation-202
**Nothing to do!** The feature is live and working.

Next time you:

1. **Merge a PR** → Workflow runs automatically, milestone allocated
2. **Close an issue** → Workflow runs automatically, milestone allocated
3. **Link issues** in PR description (Closes #123) → All items allocated together
Expand All@@ -158,6 +164,7 @@ That's it. You're done.
## 📊 Expected Behavior

### Automatic Workflow Run

```
Your PR merged
Expand All@@ -173,6 +180,7 @@ Confirmation comment posted
```

### Example Comment

```
✅ Allocated to milestone #42 "v1.5.0"

Expand All@@ -191,12 +199,14 @@ Learn more: https://github.com/lightspeedwp/.github/issues/1765
### Where to Check

**GitHub Actions:**

1. Go to [Actions](https://github.com/lightspeedwp/.github/actions)
2. Find "Allocate PR/Issue to Current Milestone"
3. Watch for recent runs
4. Check logs if any failures occur

**PR/Issue Comments:**

1. Merge a PR
2. Look for confirmation comment (usually within 2 minutes)
3. Verify milestone assigned correctly
Expand All@@ -216,6 +226,7 @@ Learn more: https://github.com/lightspeedwp/.github/issues/1765
**Have feedback?** Please comment on [#1765](https://github.com/lightspeedwp/.github/issues/1765)

We're tracking:

- What's working well
- Edge cases you encounter
- Suggestions for improvements
Expand All@@ -230,6 +241,7 @@ Your feedback helps us improve Phase 4 (Monitoring & Maintenance).
**Want to learn more?** (Optional)

We're offering a 30-minute training session covering:

- How the feature works under the hood
- Dry-run mode and testing
- Troubleshooting common issues
Expand All@@ -249,11 +261,12 @@ DM me if interested!

---

## 🎉 Thank You!
## Thank You

This feature is the result of weeks of planning, implementation, testing, and documentation.

**Special thanks to:**

- DevOps team for feedback and testing
- QA team for comprehensive test coverage
- Release managers for feature requirements
Expand Down
18 changes: 18 additions & 0 deletions .github/operations/MILESTONE_ALLOCATION_MONITORING.md
Original file line numberDiff line numberDiff line change
Expand Up@@ -10,6 +10,7 @@
## Pre-Deployment Checklist ✅

### Code & Files

- [x] Script deployed: `scripts/automation/allocate-to-milestone.js`
- [x] Workflow deployed: `.github/workflows/allocate-pr-issue-to-milestone.yml`
- [x] Tests deployed: `scripts/automation/__tests__/allocate-to-milestone.test.js`
Expand All@@ -18,12 +19,14 @@
- [x] Workflow YAML syntax valid

### Documentation

- [x] RUNBOOK.md created (392 lines)
- [x] FAQ.md created (554 lines, 52 Q&A pairs)
- [x] OPENSPEC.md updated with production section
- [x] Team announcement prepared

### Team Communication

- [x] Team announcement ready for Slack
- [x] Documentation links included
- [x] Q&A references provided
Expand All@@ -34,31 +37,37 @@
## Monitoring Checkpoints

### Hour 0-2: Initial Activation

- [ ] Announce feature to team (Slack)
- [ ] Confirm workflow is visible in GitHub Actions
- [ ] Share documentation links (RUNBOOK, FAQ)
- [ ] Set up monitoring notifications

**Success Indicators:**

- ✓ Team acknowledges announcement
- ✓ Workflow appears in Actions tab
- ✓ Documentation links working

---

### Hour 2-24: First Allocations

**When first PR is merged:**

- [ ] Watch for workflow run in GitHub Actions
- [ ] Expected time: 1-2 minutes after merge
- [ ] Verify job succeeded (green checkmark)

**When workflow completes:**

- [ ] Check PR for confirmation comment
- [ ] Expected format: "✅ Allocated to milestone #X"
- [ ] Verify milestone shows in PR sidebar
- [ ] Check linked issues also allocated (if any)

**Error Monitoring:**

- [ ] Check workflow logs for errors
- [ ] Look for any rate limit messages (429 errors)
- [ ] Verify no timeout issues (30-second timeout)
Expand All@@ -67,13 +76,16 @@
---

### Hour 24-48: Extended Monitoring

**Pattern Analysis:**

- [ ] Track successful allocations vs failures
- [ ] Expected success rate: ≥95%
- [ ] Expected error rate: <5%
- [ ] Average run time: 5-10 seconds

**Issue Tracking:**

- [ ] Are confirmation comments appearing on all items?
- [ ] Are linked issues detected correctly?
- [ ] Are milestone assignments visible?
Expand All@@ -96,24 +108,28 @@
## Sign-Off Checklist (EOD Day 6)

**Monitoring Complete:**

- [ ] 48-hour monitoring period finished
- [ ] Final success rate ≥95% verified
- [ ] All workflow logs reviewed
- [ ] No critical issues found

**Documentation:**

- [ ] Team announcement posted
- [ ] Links accessible and working
- [ ] RUNBOOK and FAQ available
- [ ] Support channel (#1765) clear

**Team Ready:**

- [ ] Team has used feature (≥5 PRs merged)
- [ ] Feedback collected
- [ ] Questions answered
- [ ] Confidence level high

**Phase 4 Ready:**

- [ ] Monitoring procedures documented
- [ ] Success metrics defined
- [ ] Escalation path clear
Expand All@@ -124,12 +140,14 @@
## Critical Success Factors

### Must Have (Phase 3 Sign-Off)

✓ ≥95% allocation success rate
✓ No critical errors
✓ Confirmation comments appearing
✓ Team using feature successfully

### Red Flags (Stop Work)

❌ Success rate <90%
❌ Systematic errors pattern
❌ Team unable to use feature
Expand Down
2 changes: 2 additions & 0 deletions .github/projects/_templates/OPENSPEC_TEMPLATE.md
Original file line numberDiff line numberDiff line change
Expand Up@@ -408,9 +408,11 @@ describe('Component A', () => {
**Request Example:**

```bash
# gitleaks:allow
curl -X GET \
https://api.example.com/api/v1/resource/550e8400-e29b-41d4-a716-446655440000 \
-H 'Authorization: Bearer token123'
# gitleaks:allowlist
```

**Success Response (200 OK):**
Expand Down
Loading
Loading