sg/msp: update CloudDeploy helper comment (#61164)

Author: jac

dev/sg/msp/helpers.go

@@ -194,7 +194,7 @@ func generateTerraform(serviceID string, opts generateTerraformOptions) error {
 			}
 
 			deploySpecFilename := fmt.Sprintf("rollout-%s.clouddeploy.yaml", region)
-			comment := generateCloudDeployDocstring(env.ProjectID, region, deploySpecFilename)
+			comment := generateCloudDeployDocstring(env.ProjectID, serviceID, region, deploySpecFilename)
 			if err := os.WriteFile(
 				filepath.Join(filepath.Dir(serviceSpecPath), deploySpecFilename),
 				append([]byte(comment), deploySpec.Bytes()...),
@@ -247,20 +247,20 @@ func isHandbookRepo(relPath string) error {
 	return errors.Newf("unexpected package %q", packageJSON.Name)
 }
 
-func generateCloudDeployDocstring(projectID, gcpRegion, cloudDeployFilename string) string {
+func generateCloudDeployDocstring(projectID, serviceID, gcpRegion, cloudDeployFilename string) string {
 	return fmt.Sprintf(`# DO NOT EDIT; generated by 'sg msp generate'
 #
 # This file defines additional Cloud Deploy configuration that is not yet available in Terraform.
 # Apply this using the following command:
 #
-#   gcloud deploy apply --project=%[1]s --region=%[2]s --file=%[3]s
+#   gcloud deploy apply --project=%[1]s --region=%[3]s --file=%[4]s
 #
 # Releases can be created using the following command, which can be added to CI pipelines:
 #
-#   gcloud deploy releases create $RELEASE_NAME --labels="commit=$COMMIT,author=$AUTHOR" --deploy-parameters="customTarget/tag=$TAG" --project=%[1]s --region=%[2]s --delivery-pipeline=%[1]s-%[2]s-rollout --source='gs://%[1]s-cloudrun-skaffold/source.tar.gz'
+#   gcloud deploy releases create $RELEASE_NAME --labels="commit=$COMMIT,author=$AUTHOR" --deploy-parameters="customTarget/tag=$TAG" --project=%[1]s --region=%[3]s --delivery-pipeline=%[2]s-%[3]s-rollout --source='gs://%[1]s-cloudrun-skaffold/source.tar.gz'
 #
 # The secret 'cloud_deploy_releaser_service_account_id' provides the ID of a service account
 # that can be used to provision workload auth, for example https://sourcegraph.sourcegraph.com/github.com/sourcegraph/infrastructure/-/blob/managed-services/continuous-deployment-pipeline/main.tf?L5-20
 `, // TODO improve the releases DX
-		projectID, gcpRegion, cloudDeployFilename)
+		projectID, serviceID, gcpRegion, cloudDeployFilename)
 }

dev/sg/msp/helpers_test.go

@@ -7,7 +7,7 @@ import (
 )
 
 func TestGenerateCloudDeployDocstring(t *testing.T) {
-	comment := generateCloudDeployDocstring("PROJECT_ID", "REGION", "rollout-REGION.clouddeploy.yaml")
+	comment := generateCloudDeployDocstring("PROJECT_ID", "SERVICE_ID", "REGION", "rollout-REGION.clouddeploy.yaml")
 	autogold.Expect(`# DO NOT EDIT; generated by 'sg msp generate'
 #
 # This file defines additional Cloud Deploy configuration that is not yet available in Terraform.
@@ -17,7 +17,7 @@ func TestGenerateCloudDeployDocstring(t *testing.T) {
 #
 # Releases can be created using the following command, which can be added to CI pipelines:
 #
-#   gcloud deploy releases create $RELEASE_NAME --labels="commit=$COMMIT,author=$AUTHOR" --deploy-parameters="customTarget/tag=$TAG" --project=PROJECT_ID --region=REGION --delivery-pipeline=PROJECT_ID-REGION-rollout --source='gs://PROJECT_ID-cloudrun-skaffold/source.tar.gz'
+#   gcloud deploy releases create $RELEASE_NAME --labels="commit=$COMMIT,author=$AUTHOR" --deploy-parameters="customTarget/tag=$TAG" --project=PROJECT_ID --region=REGION --delivery-pipeline=SERVICE_ID-REGION-rollout --source='gs://PROJECT_ID-cloudrun-skaffold/source.tar.gz'
 #
 # The secret 'cloud_deploy_releaser_service_account_id' provides the ID of a service account
 # that can be used to provision workload auth, for example https://sourcegraph.sourcegraph.com/github.com/sourcegraph/infrastructure/-/blob/managed-services/continuous-deployment-pipeline/main.tf?L5-20