minor improvements based on feedback.

internal/pkg/githubapi/github.go

@@ -1149,7 +1149,7 @@ func generatePromotionPrBody(ghPrClientDetails GhPrClientDetails, components str
 // when we have multiple components, we are going to use the component that has the fewest skip paths
 func getPromotionSkipPaths(promotion PromotionInstance) map[string]bool {
 	perComponentSkippedTargetPaths := promotion.Metadata.PerComponentSkippedTargetPaths
-	promotionSkipPaths := make(map[string]bool)
+	promotionSkipPaths := map[string]bool{}
 
 	// if any promoted component is not in the perComponentSkippedTargetPaths
 	// then that means we have a component that is promoted to all paths,
@@ -1161,7 +1161,6 @@ func getPromotionSkipPaths(promotion PromotionInstance) map[string]bool {
 		}
 	}
 
-
 	if len(perComponentSkippedTargetPaths) == 0 {
 		return promotionSkipPaths
 	}
@@ -1197,6 +1196,10 @@ func prBody(keys []int, newPrMetadata prMetadata, newPrBody string, promotionSki
 	sp := ""
 	tp := ""
 
+	// sort the paths so that we have a predictable order for tests
+	// and better readability for users
+	sort.Strings(newPrMetadata.PromotedPaths)
+
 	for i, k := range keys {
 		sp = newPrMetadata.PreviousPromotionMetadata[k].SourcePath
 		x := filterSkipPaths(newPrMetadata.PreviousPromotionMetadata[k].TargetPaths, promotionSkipPaths)
@@ -1226,8 +1229,6 @@ func filterSkipPaths(targetPaths []string, promotionSkipPaths map[string]bool) [
 		}
 	}
 
-	sort.Strings(paths)
-
 	return paths
 }