Skip to content

Commit 8234032

Browse files
craig[bot]spilchenceliala
committed
158684: sql: extend SST writer support to legacy schema changer backfill r=spilchen a=spilchen Previously, SST writer support during index backfill with distributed merge was only available in the declarative schema changer (added in #158456). This commit extends the same logic to the legacy schema changer. To avoid duplication, shared logic was extracted into a helper function reused by both. Informs #158378 Epic: CRDB-48845 Release note: none 158832: clusterversion: update M3 M4 runbooks r=rail a=celiala This PR: - adds a note to update `sqllogic_corpus_nightly_impl.sh` which was - correctly done for 25.3 bump (#157767), - but missed for 25.4 bump (#158225) - adds a "quick reference" version for M3 and M4 runbooks, to mitigate bot confusion. Improvements related to: - #158817 - #158741 Release note: None Epic: None Co-authored-by: Matt Spilchen <[email protected]> Co-authored-by: Celia La <[email protected]>
3 parents 114aa82 + 66ce999 + de56863 commit 8234032

File tree

15 files changed

+1353
-140
lines changed

15 files changed

+1353
-140
lines changed

pkg/clusterversion/CLAUDE.md

Lines changed: 14 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -12,7 +12,9 @@ This document provides an overview of the quarterly release preparation tasks wi
1212
- [M.1: Bump Current Version](runbooks/M1_bump_current_version.md) - Advance master to next development version
1313
- [M.2: Enable Mixed-Cluster Logic Tests](runbooks/M2_enable_mixed_cluster_logic_tests.md) - Add bootstrap data and test configs
1414
- [M.3: Enable Upgrade Tests](runbooks/M3_enable_upgrade_tests.md) - Generate fixtures and enable roachtests
15+
- [M.3 Quick Reference](runbooks/M3_enable_upgrade_tests_QUICK.md) - Streamlined checklist version
1516
- [M.4: Bump MinSupported Version](runbooks/M4_bump_minsupported_version.md) - Remove support for oldest version
17+
- [M.4 Quick Reference](runbooks/M4_bump_minsupported_version_QUICK.md) - Streamlined checklist version
1618

1719
## For Claude Code AI
1820

@@ -21,17 +23,25 @@ This document provides an overview of the quarterly release preparation tasks wi
2123
When the user asks you to perform a release task (e.g., "perform M.1", "do the M.2 task", "help with R.1"):
2224

2325
1. **Read the appropriate runbook** from the `runbooks/` directory using the Read tool
26+
- **Prefer QUICK versions when available** (e.g., `M4_bump_minsupported_version_QUICK.md`)
27+
- Quick versions are streamlined checklists optimized for execution
28+
- Full versions have detailed explanations and troubleshooting
2429
2. **Follow the runbook exactly** - it contains step-by-step instructions, expected files, and common errors
2530
3. **Use the TodoWrite tool** to track your progress through the runbook steps
2631
4. **Ask clarifying questions** if the runbook is unclear or doesn't match the current codebase state
32+
5. **Reference the full runbook** when you encounter errors or need deeper explanation
2733

2834
**Adding new runbooks:**
2935

3036
1. **Create a new file** in `pkg/clusterversion/runbooks/` following the naming pattern: `{R|M}N_descriptive_name.md`
31-
2. **Update this file** to add the new runbook to the Quick Navigation section
32-
3. **Update `pkg/clusterversion/README.md`** with a "Claude Prompt" section that references the new runbook
33-
4. **Follow the existing structure:** Use consistent header levels (# for title, ## for major sections, ### for subsections)
34-
5. **Include these sections:** Overview, Prerequisites, Step-by-Step Checklist, Expected Files Modified, Validation/Verification, Common Errors, Quick Reference Commands
37+
2. **Consider creating a QUICK version** for complex tasks (e.g., `{R|M}N_descriptive_name_QUICK.md`)
38+
- Quick versions should be action-oriented checklists
39+
- Use tables, bullet points, and minimal prose
40+
- Focus on WHAT to do, not WHY
41+
3. **Update this file** to add the new runbook to the Quick Navigation section
42+
4. **Update `pkg/clusterversion/README.md`** with a "Claude Prompt" section that references the new runbook
43+
5. **Follow the existing structure:** Use consistent header levels (# for title, ## for major sections, ### for subsections)
44+
6. **Include these sections:** Overview, Prerequisites, Step-by-Step Checklist, Expected Files Modified, Validation/Verification, Common Errors, Quick Reference Commands
3545

3646
## Runbook Structure Guidelines
3747

pkg/clusterversion/runbooks/M3_enable_upgrade_tests.md

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -2,6 +2,10 @@
22

33
This section provides step-by-step instructions for the M.3 task: "Enable upgrade tests" on the master branch after the first RC is published. This task enables roachtest upgrade tests with the newly released version.
44

5+
**📋 Quick Reference:** For a streamlined checklist-style guide, see [`M3_enable_upgrade_tests_QUICK.md`](M3_enable_upgrade_tests_QUICK.md). This document provides detailed explanations and troubleshooting.
6+
7+
---
8+
59
### Overview
610

711
**When to perform:** After the first RC (e.g., v25.4.0-rc.1) is published and available on the releases page.

0 commit comments

Comments
 (0)