Prevent branches ending with dash (#119)

danielfn · web-flow · commit c3ab8ff947f6 · 2025-05-29T10:15:10.000+02:00
* fix: prevent branches ending with dashes
* fix: skip sonar check if repo is a fork
* fix: skip sonar check if repo is a fork, for sonar-branch-analysis
diff --git a/.github/workflows/PR-verify.yml b/.github/workflows/PR-verify.yml
@@ -29,6 +29,7 @@ jobs:
           make verify
 
       - name: SonarCloud Scan
+        if: ${{ vars.IS_INDITEXTECH_REPO == 'true' }}
         uses: sonarsource/sonarcloud-github-action@master
         env:
           GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
@@ -70,4 +71,4 @@ jobs:
           ref: ${{ github.event.pull_request.head.sha }}
 
       - name: REUSE Compliance Check
-        uses: fsfe/reuse-action@v3
+        uses: fsfe/reuse-action@v3
diff --git a/.github/workflows/sonar-branch-analysis.yml b/.github/workflows/sonar-branch-analysis.yml
@@ -12,7 +12,7 @@ env:
 
 jobs:
   verify:
-    if: github.event.pull_request.merged == true
+    if: ${{ github.event.pull_request.merged == true && vars.IS_INDITEXTECH_REPO == 'true' }}
     name: Verify
     runs-on: ubuntu-latest
     steps:
@@ -37,4 +37,4 @@ jobs:
           SONAR_TOKEN: ${{ secrets.SONAR_TOKEN }}
         with:
           args: >
-            -Dsonar.branch.name=main
+            -Dsonar.branch.name=main
diff --git a/internal/branches/branches.go b/internal/branches/branches.go
@@ -120,7 +120,9 @@ func (b BranchProvider) formatBranchName(repoNameWithOwner string, branchType st
 		branchName = branchName[:min(maxBranchNameLength, branchNameLength)]
 	}
 
-	return strings.TrimSuffix(branchName, "-")
+	// Remove all trailing dashes to ensure branches never end with a dash
+	trailingDashPattern := regexp.MustCompile(`-+$`)
+	return trailingDashPattern.ReplaceAllString(branchName, "")
 }
 
 // min returns the smallest of x or y.
diff --git a/internal/branches/branches_test.go b/internal/branches/branches_test.go
@@ -283,6 +283,39 @@ func TestFormatBranchName(t *testing.T) {
 			},
 			want: "feature/GH-1-this-is-a-very-long-title-that-will-not-be-cropped",
 		},
+		{
+			name: "Does not end with dash when truncating at single dash",
+			args: args{
+				repository:   repositoryName,
+				branchType:   "feature",
+				issueId:      "JIRA-123",
+				issueContext: "back-do-something",
+				maxLength:    43, // "InditexTech/gh-sherpa" (21) + "feature/JIRA-123-back-" (22) = 43, so this truncates to "feature/JIRA-123-back-"
+			},
+			want: "feature/JIRA-123-back",
+		},
+		{
+			name: "Does not end with dash when truncating at multiple dashes",
+			args: args{
+				repository:   repositoryName,
+				branchType:   "feature",
+				issueId:      "JIRA-123",
+				issueContext: "back--user",
+				maxLength:    44, // This will truncate to "feature/JIRA-123-back--" and should become "feature/JIRA-123-back"
+			},
+			want: "feature/JIRA-123-back",
+		},
+		{
+			name: "Does not end with dash when truncating at multiple consecutive dashes",
+			args: args{
+				repository:   repositoryName,
+				branchType:   "feature",
+				issueId:      "JIRA-123",
+				issueContext: "back---user-do-something",
+				maxLength:    45, // This will truncate to "feature/JIRA-123-back---" and should become "feature/JIRA-123-back"
+			},
+			want: "feature/JIRA-123-back",
+		},
 	}
 
 	for _, tt := range tests {

Original file line number	Diff line number	Diff line change
`@@ -120,7 +120,9 @@ func (b BranchProvider) formatBranchName(repoNameWithOwner string, branchType st`
`120`	`120`	`branchName = branchName[:min(maxBranchNameLength, branchNameLength)]`
`121`	`121`	`}`
`122`	`122`
`123`		`- return strings.TrimSuffix(branchName, "-")`
	`123`	`+ // Remove all trailing dashes to ensure branches never end with a dash`
	`124`	+ trailingDashPattern := regexp.MustCompile(`-+$`)
	`125`	`+ return trailingDashPattern.ReplaceAllString(branchName, "")`
`124`	`126`	`}`
`125`	`127`
`126`	`128`	`// min returns the smallest of x or y.`