|
| 1 | +// Copyright 2025 The Cockroach Authors. |
| 2 | +// |
| 3 | +// Use of this software is governed by the CockroachDB Software License |
| 4 | +// included in the /LICENSE file. |
| 5 | + |
| 6 | +package main |
| 7 | + |
| 8 | +import ( |
| 9 | + "fmt" |
| 10 | + "log" |
| 11 | + "os" |
| 12 | + "slices" |
| 13 | + "strings" |
| 14 | + |
| 15 | + "github.com/cockroachdb/version" |
| 16 | + "github.com/spf13/cobra" |
| 17 | +) |
| 18 | + |
| 19 | +const workflowFile = ".github/workflows/update_releases.yaml" |
| 20 | + |
| 21 | +var updateWorkflowBranchesCmd = &cobra.Command{ |
| 22 | + Use: "update-workflow-branches", |
| 23 | + Short: "Update the branch matrix in update_releases.yaml workflow", |
| 24 | + Long: "Detects the latest release branch and adds it to the GitHub Actions workflow if not present", |
| 25 | + RunE: updateWorkflowBranches, |
| 26 | +} |
| 27 | + |
| 28 | +// updateWorkflowBranches is the main command handler. |
| 29 | +func updateWorkflowBranches(_ *cobra.Command, _ []string) error { |
| 30 | + fmt.Println("Finding latest release branch...") |
| 31 | + latestBranch, err := findLatestReleaseBranch() |
| 32 | + if err != nil { |
| 33 | + return fmt.Errorf("failed to find latest release branch: %w", err) |
| 34 | + } |
| 35 | + |
| 36 | + fmt.Printf("Latest release branch: %s\n", latestBranch) |
| 37 | + |
| 38 | + fmt.Println("Updating workflow file...") |
| 39 | + if err := addBranchToWorkflow(latestBranch); err != nil { |
| 40 | + return fmt.Errorf("failed to update workflow file: %w", err) |
| 41 | + } |
| 42 | + |
| 43 | + fmt.Println("Successfully updated workflow file") |
| 44 | + return nil |
| 45 | +} |
| 46 | + |
| 47 | +// findLatestReleaseBranch detects the latest release branch by querying git remote branches. |
| 48 | +func findLatestReleaseBranch() (string, error) { |
| 49 | + // Get all release branches |
| 50 | + branches, err := listRemoteBranches("release-*") |
| 51 | + if err != nil { |
| 52 | + return "", fmt.Errorf("failed to list remote branches: %w", err) |
| 53 | + } |
| 54 | + |
| 55 | + // Filter out RC branches - we only want major release branches like "release-25.4" |
| 56 | + var releaseBranches []string |
| 57 | + for _, branch := range branches { |
| 58 | + if !strings.Contains(branch, "-rc") { |
| 59 | + releaseBranches = append(releaseBranches, branch) |
| 60 | + } |
| 61 | + } |
| 62 | + |
| 63 | + if len(releaseBranches) == 0 { |
| 64 | + return "", fmt.Errorf("no release branches found") |
| 65 | + } |
| 66 | + |
| 67 | + // Parse versions and sort |
| 68 | + type branchVersion struct { |
| 69 | + branch string |
| 70 | + version version.Version |
| 71 | + } |
| 72 | + var versions []branchVersion |
| 73 | + |
| 74 | + for _, branch := range releaseBranches { |
| 75 | + // Extract version from "release-X.Y" format |
| 76 | + versionStr := strings.TrimPrefix(branch, "release-") |
| 77 | + // Add .0 for patch to make it a valid semantic version |
| 78 | + v, err := version.Parse("v" + versionStr + ".0") |
| 79 | + if err != nil { |
| 80 | + log.Printf("WARNING: cannot parse version from branch %s: %v", branch, err) |
| 81 | + continue |
| 82 | + } |
| 83 | + versions = append(versions, branchVersion{branch, v}) |
| 84 | + } |
| 85 | + |
| 86 | + if len(versions) == 0 { |
| 87 | + return "", fmt.Errorf("no valid version branches found") |
| 88 | + } |
| 89 | + |
| 90 | + // Sort by version |
| 91 | + slices.SortFunc(versions, func(a, b branchVersion) int { |
| 92 | + return a.version.Compare(b.version) |
| 93 | + }) |
| 94 | + |
| 95 | + // Return highest version |
| 96 | + return versions[len(versions)-1].branch, nil |
| 97 | +} |
| 98 | + |
| 99 | +// addBranchToWorkflow adds the specified branch to the workflow file if not already present. |
| 100 | +func addBranchToWorkflow(branch string) error { |
| 101 | + // Read the workflow file |
| 102 | + rawData, err := os.ReadFile(workflowFile) |
| 103 | + if err != nil { |
| 104 | + return fmt.Errorf("failed to read workflow file: %w", err) |
| 105 | + } |
| 106 | + |
| 107 | + lines := strings.Split(string(rawData), "\n") |
| 108 | + |
| 109 | + // Find the branch section and extract current branches |
| 110 | + currentBranches, branchStart, branchEnd, indent, err := parseBranchSection(lines) |
| 111 | + if err != nil { |
| 112 | + return err |
| 113 | + } |
| 114 | + |
| 115 | + // Check if branch already exists |
| 116 | + for _, b := range currentBranches { |
| 117 | + if b == branch { |
| 118 | + fmt.Printf("Branch %s is already in the workflow file\n", branch) |
| 119 | + return nil |
| 120 | + } |
| 121 | + } |
| 122 | + |
| 123 | + // Add the new branch |
| 124 | + currentBranches = append(currentBranches, branch) |
| 125 | + |
| 126 | + // Sort branches: master first, then release branches in version order |
| 127 | + slices.SortFunc(currentBranches, func(a, b string) int { |
| 128 | + if a == "master" { |
| 129 | + return -1 |
| 130 | + } |
| 131 | + if b == "master" { |
| 132 | + return 1 |
| 133 | + } |
| 134 | + |
| 135 | + // Compare release versions |
| 136 | + aVer := strings.TrimPrefix(a, "release-") |
| 137 | + bVer := strings.TrimPrefix(b, "release-") |
| 138 | + |
| 139 | + va, err1 := version.Parse("v" + aVer + ".0") |
| 140 | + vb, err2 := version.Parse("v" + bVer + ".0") |
| 141 | + |
| 142 | + // If either fails to parse, fall back to string comparison |
| 143 | + if err1 != nil || err2 != nil { |
| 144 | + return strings.Compare(a, b) |
| 145 | + } |
| 146 | + |
| 147 | + return va.Compare(vb) |
| 148 | + }) |
| 149 | + |
| 150 | + // Write the updated file |
| 151 | + if err := writeBranchSection(lines, currentBranches, branchStart, branchEnd, indent); err != nil { |
| 152 | + return err |
| 153 | + } |
| 154 | + |
| 155 | + fmt.Printf("Added branch %s to workflow file\n", branch) |
| 156 | + return nil |
| 157 | +} |
| 158 | + |
| 159 | +// parseBranchSection parses the workflow file to find the branch matrix section. |
| 160 | +func parseBranchSection( |
| 161 | + lines []string, |
| 162 | +) (branches []string, start int, end int, indent string, err error) { |
| 163 | + start = -1 |
| 164 | + end = -1 |
| 165 | + |
| 166 | + for i, line := range lines { |
| 167 | + // Look for "branch:" within the matrix section |
| 168 | + if strings.Contains(line, "branch:") && !strings.HasPrefix(strings.TrimSpace(line), "#") { |
| 169 | + start = i + 1 |
| 170 | + // Determine indentation from the next line |
| 171 | + if i+1 < len(lines) { |
| 172 | + nextLine := lines[i+1] |
| 173 | + // Count leading spaces |
| 174 | + trimmed := strings.TrimLeft(nextLine, " ") |
| 175 | + indent = strings.Repeat(" ", len(nextLine)-len(trimmed)) |
| 176 | + } |
| 177 | + } else if start != -1 && end == -1 { |
| 178 | + // Check if this line is still part of branch list |
| 179 | + trimmed := strings.TrimSpace(line) |
| 180 | + if trimmed == "" { |
| 181 | + // Empty line, continue |
| 182 | + continue |
| 183 | + } |
| 184 | + if !strings.HasPrefix(trimmed, "-") { |
| 185 | + // Found the end of the branch list |
| 186 | + end = i |
| 187 | + break |
| 188 | + } else { |
| 189 | + // Extract branch name from line like '- "release-25.4"' |
| 190 | + // Remove leading "- " and quotes |
| 191 | + branchLine := strings.TrimSpace(trimmed) |
| 192 | + branchLine = strings.TrimPrefix(branchLine, "- ") |
| 193 | + branchLine = strings.Trim(branchLine, "\"") |
| 194 | + branches = append(branches, branchLine) |
| 195 | + } |
| 196 | + } |
| 197 | + } |
| 198 | + |
| 199 | + if start == -1 { |
| 200 | + return nil, 0, 0, "", fmt.Errorf("branch section not found in workflow file") |
| 201 | + } |
| 202 | + |
| 203 | + // If we reached end of file, set end to len(lines) |
| 204 | + if end == -1 { |
| 205 | + end = len(lines) |
| 206 | + } |
| 207 | + |
| 208 | + return branches, start, end, indent, nil |
| 209 | +} |
| 210 | + |
| 211 | +// writeBranchSection writes the updated branch list back to the workflow file. |
| 212 | +func writeBranchSection( |
| 213 | + lines []string, branches []string, start int, end int, indent string, |
| 214 | +) error { |
| 215 | + // Build new lines |
| 216 | + var newLines []string |
| 217 | + newLines = append(newLines, lines[:start]...) |
| 218 | + |
| 219 | + // Add branch lines |
| 220 | + for _, branch := range branches { |
| 221 | + newLines = append(newLines, fmt.Sprintf("%s- %q", indent, branch)) |
| 222 | + } |
| 223 | + |
| 224 | + // Add remaining lines |
| 225 | + newLines = append(newLines, lines[end:]...) |
| 226 | + |
| 227 | + // Write back to file using atomic write pattern |
| 228 | + // Create temp file in the same directory as target to avoid cross-device link errors |
| 229 | + dir := ".github/workflows" |
| 230 | + f, err := os.CreateTemp(dir, "update_releases_*.yaml") |
| 231 | + if err != nil { |
| 232 | + return fmt.Errorf("could not create temporary file: %w", err) |
| 233 | + } |
| 234 | + tmpName := f.Name() |
| 235 | + defer func() { |
| 236 | + if err != nil { |
| 237 | + _ = os.Remove(tmpName) |
| 238 | + } |
| 239 | + }() |
| 240 | + |
| 241 | + if _, err = f.WriteString(strings.Join(newLines, "\n")); err != nil { |
| 242 | + f.Close() |
| 243 | + return fmt.Errorf("error writing to temp file: %w", err) |
| 244 | + } |
| 245 | + |
| 246 | + if err = f.Close(); err != nil { |
| 247 | + return fmt.Errorf("error closing temp file: %w", err) |
| 248 | + } |
| 249 | + |
| 250 | + if err = os.Rename(tmpName, workflowFile); err != nil { |
| 251 | + return fmt.Errorf("error moving file to final destination: %w", err) |
| 252 | + } |
| 253 | + |
| 254 | + return nil |
| 255 | +} |
0 commit comments