Fix breaking-change unit test (#12693)

GoogleCloudPlatform · Jan 6, 2025 · 9e815a4 · 9e815a4
1 parent c377f37
commit 9e815a4
Show file tree

Hide file tree

Showing 3 changed files with 14 additions and 13 deletions.
diff --git a/.github/workflows/unit-test-tools.yml b/.github/workflows/unit-test-tools.yml
@@ -5,6 +5,7 @@ permissions: read-all
 on:
   pull_request:
     paths:
+      - 'docs/**'
       - 'tools/**'
       - '.github/workflows/unit-test-tools.yml'
 

diff --git a/tools/diff-processor/breaking_changes/breaking_changes.go b/tools/diff-processor/breaking_changes/breaking_changes.go
@@ -14,7 +14,7 @@ type BreakingChange struct {
 	RuleName               string
 }
 
-const breakingChangesPath = "develop/breaking-changes/breaking-changes"
+const breakingChangesPath = "breaking-changes/breaking-changes"
 
 func NewBreakingChange(message, identifier string) BreakingChange {
 	return BreakingChange{

diff --git a/tools/diff-processor/breaking_changes/breaking_changes_test.go b/tools/diff-processor/breaking_changes/breaking_changes_test.go
@@ -94,7 +94,7 @@ func TestComputeBreakingChanges(t *testing.T) {
 			wantViolations: []BreakingChange{
 				{
 					Message:                "Resource `google-x` was either removed or renamed",
-					DocumentationReference: "https://googlecloudplatform.github.io/magic-modules/develop/breaking-changes/breaking-changes#resource-map-resource-removal-or-rename",
+					DocumentationReference: "https://googlecloudplatform.github.io/magic-modules/breaking-changes/breaking-changes#resource-map-resource-removal-or-rename",
 				},
 			},
 		},
@@ -118,7 +118,7 @@ func TestComputeBreakingChanges(t *testing.T) {
 			wantViolations: []BreakingChange{
 				{
 					Message:                "Field `field-b` within resource `google-x` was either removed or renamed",
-					DocumentationReference: "https://googlecloudplatform.github.io/magic-modules/develop/breaking-changes/breaking-changes#resource-schema-field-removal-or-rename",
+					DocumentationReference: "https://googlecloudplatform.github.io/magic-modules/breaking-changes/breaking-changes#resource-schema-field-removal-or-rename",
 				},
 			},
 		},
@@ -143,7 +143,7 @@ func TestComputeBreakingChanges(t *testing.T) {
 			wantViolations: []BreakingChange{
 				{
 					Message:                "Field `field-a` changed from optional to required on `google-x`",
-					DocumentationReference: "https://googlecloudplatform.github.io/magic-modules/develop/breaking-changes/breaking-changes#field-optional-to-required",
+					DocumentationReference: "https://googlecloudplatform.github.io/magic-modules/breaking-changes/breaking-changes#field-optional-to-required",
 				},
 			},
 		},
@@ -167,11 +167,11 @@ func TestComputeBreakingChanges(t *testing.T) {
 			wantViolations: []BreakingChange{
 				{
 					Message:                "Field `field-a` changed from optional to required on `google-x`",
-					DocumentationReference: "https://googlecloudplatform.github.io/magic-modules/develop/breaking-changes/breaking-changes#field-optional-to-required",
+					DocumentationReference: "https://googlecloudplatform.github.io/magic-modules/breaking-changes/breaking-changes#field-optional-to-required",
 				},
 				{
 					Message:                "Field `field-b` within resource `google-x` was either removed or renamed",
-					DocumentationReference: "https://googlecloudplatform.github.io/magic-modules/develop/breaking-changes/breaking-changes#resource-schema-field-removal-or-rename",
+					DocumentationReference: "https://googlecloudplatform.github.io/magic-modules/breaking-changes/breaking-changes#resource-schema-field-removal-or-rename",
 				},
 			},
 		},
@@ -200,15 +200,15 @@ func TestComputeBreakingChanges(t *testing.T) {
 			wantViolations: []BreakingChange{
 				{
 					Message:                "Field `field-a` changed from optional to required on `google-x`",
-					DocumentationReference: "https://googlecloudplatform.github.io/magic-modules/develop/breaking-changes/breaking-changes#field-optional-to-required",
+					DocumentationReference: "https://googlecloudplatform.github.io/magic-modules/breaking-changes/breaking-changes#field-optional-to-required",
 				},
 				{
 					Message:                "Field `field-b` within resource `google-x` was either removed or renamed",
-					DocumentationReference: "https://googlecloudplatform.github.io/magic-modules/develop/breaking-changes/breaking-changes#resource-schema-field-removal-or-rename",
+					DocumentationReference: "https://googlecloudplatform.github.io/magic-modules/breaking-changes/breaking-changes#resource-schema-field-removal-or-rename",
 				},
 				{
 					Message:                "Resource `google-y` was either removed or renamed",
-					DocumentationReference: "https://googlecloudplatform.github.io/magic-modules/develop/breaking-changes/breaking-changes#resource-map-resource-removal-or-rename",
+					DocumentationReference: "https://googlecloudplatform.github.io/magic-modules/breaking-changes/breaking-changes#resource-map-resource-removal-or-rename",
 				},
 			},
 		},
@@ -254,7 +254,7 @@ func TestComputeBreakingChanges(t *testing.T) {
 			wantViolations: []BreakingChange{
 				{
 					Message:                "Field `field-a.sub-field-2` within resource `google-x` was either removed or renamed",
-					DocumentationReference: "https://googlecloudplatform.github.io/magic-modules/develop/breaking-changes/breaking-changes#resource-schema-field-removal-or-rename",
+					DocumentationReference: "https://googlecloudplatform.github.io/magic-modules/breaking-changes/breaking-changes#resource-schema-field-removal-or-rename",
 				},
 			},
 		},
@@ -299,7 +299,7 @@ func TestComputeBreakingChanges(t *testing.T) {
 			wantViolations: []BreakingChange{
 				{
 					Message:                "Field `field-a.sub-field-1` MinItems went from 100 to 25 on `google-x`",
-					DocumentationReference: "https://googlecloudplatform.github.io/magic-modules/develop/breaking-changes/breaking-changes#field-shrinking-max",
+					DocumentationReference: "https://googlecloudplatform.github.io/magic-modules/breaking-changes/breaking-changes#field-shrinking-max",
 				},
 			},
 		},
@@ -344,7 +344,7 @@ func TestComputeBreakingChanges(t *testing.T) {
 			wantViolations: []BreakingChange{
 				{
 					Message:                "Field `field-a.sub-field-1` MinItems went from 100 to 25 on `google-x`",
-					DocumentationReference: "https://googlecloudplatform.github.io/magic-modules/develop/breaking-changes/breaking-changes#field-shrinking-max",
+					DocumentationReference: "https://googlecloudplatform.github.io/magic-modules/breaking-changes/breaking-changes#field-shrinking-max",
 				},
 			},
 		},
@@ -375,7 +375,7 @@ func TestComputeBreakingChanges(t *testing.T) {
 			wantViolations: []BreakingChange{
 				{
 					Message:                "Field `field-a` MinItems went from 1 to 4 on `google-x`",
-					DocumentationReference: "https://googlecloudplatform.github.io/magic-modules/develop/breaking-changes/breaking-changes#field-growing-min",
+					DocumentationReference: "https://googlecloudplatform.github.io/magic-modules/breaking-changes/breaking-changes#field-growing-min",
 				},
 			},
 		},