Adding support for pipeline installs in other branches

Author: mtarng

guides/hld-management.md

@@ -102,14 +102,15 @@ Usage: hld install-manifest-pipeline|p [options]
 Install the manifest generation pipeline to your Azure DevOps instance. Default values are set in spk-config.yaml and can be loaded via spk init or overriden via option flags.
 
 Options:
-  -n, --pipeline-name <pipeline-name>                  Name of the pipeline to be created
-  -p, --personal-access-token <personal-access-token>  Personal Access Token
-  -o, --org-name <org-name>                            Organization Name for Azure DevOps
-  -r, --hld-name <hld-name>                            HLD Repository Name in Azure DevOps
-  -u, --hld-url <hld-url>                              HLD Repository URL
-  -m, --manifest-url <manifest-url>                    Manifest Repository URL
-  -d, --devops-project <devops-project>                Azure DevOps Project
-  -b, --build-script-url <build-script-url>            Build Script URL. By default it is 'https://raw.githubusercontent.com/Microsoft/bedrock/master/gitops/azure-devops/build.sh'.
+  -n, --pipeline-name <pipeline-name>                  Name of the pipeline to be created (default: "")
+  -p, --personal-access-token <personal-access-token>  Personal Access Token (default: "")
+  -o, --org-name <org-name>                            Organization Name for Azure DevOps (default: "")
+  -r, --hld-name <hld-name>                            HLD Repository Name in Azure DevOps (default: "")
+  -u, --hld-url <hld-url>                              HLD Repository URL (default: "")
+  -m, --manifest-url <manifest-url>                    Manifest Repository URL (default: "")
+  -d, --devops-project <devops-project>                Azure DevOps Project (default: "")
+  -b, --build-script-url <build-script-url>            Build Script URL. By default it is 'https://raw.githubusercontent.com/Microsoft/bedrock/master/gitops/azure-devops/build.sh'. (default: "https://raw.githubusercontent.com/Microsoft/bedrock/master/gitops/azure-devops/build.sh")
+  --yaml-file-branch <yaml-file-branch>                The git branch where the pipeline definition yaml file is located. (default: "master")
   -h, --help                                           output usage information
 ```
 

guides/project-management.md

@@ -117,6 +117,7 @@ Options:
   -r, --repo-name <repo-name>                          Repository Name in Azure DevOps
   -u, --repo-url <repo-url>                            Repository URL
   -d, --devops-project <devops-project>                Azure DevOps Project
-  -b, --build-script-url <build-script-url>            Build Script URL. By default it is 'https://raw.githubusercontent.com/Microsoft/bedrock/master/gitops/azure-devops/build.sh'.
+  -b, --build-script-url <build-script-url>            Build Script URL. By default it is https://raw.githubusercontent.com/Microsoft/bedrock/master/gitops/azure-devops/build.sh.
+  --yaml-file-branch <yaml-file-branch>                The git branch where the pipeline definition yaml file is located. (default: "master")
   -h, --help                                           output usage information
 ```

guides/service-management.md

@@ -98,14 +98,15 @@ Usage: service install-build-pipeline|p [options] <service-name>
 Install the build and push to acr pipeline for a service to your Azure DevOps instance
 
 Options:
-  -n, --pipeline-name <pipeline-name>                  Name of the pipeline to be created
-  -p, --personal-access-token <personal-access-token>  Personal Access Token
-  -o, --org-name <org-name>                            Organization Name for Azure DevOps
-  -r, --repo-name <repo-name>                          Repository Name in Azure DevOps
-  -u, --repo-url <repo-url>                            Repository URL
-  -d, --devops-project <devops-project>                Azure DevOps Project
-  -b, --build-script-url <build-script-url>            Build Script URL. By default it is 'https://raw.githubusercontent.com/Microsoft/bedrock/master/gitops/azure-devops/build.sh'.
+  -n, --pipeline-name <pipeline-name>                  Name of the pipeline to be created (default: "")
+  -p, --personal-access-token <personal-access-token>  Personal Access Token (default: "")
+  -o, --org-name <org-name>                            Organization Name for Azure DevOps (default: "")
+  -r, --repo-name <repo-name>                          Repository Name in Azure DevOps (default: "")
+  -u, --repo-url <repo-url>                            Repository URL (default: "")
+  -d, --devops-project <devops-project>                Azure DevOps Project (default: "")
+  -b, --build-script-url <build-script-url>            Build Script URL. By default it is 'https://raw.githubusercontent.com/Microsoft/bedrock/master/gitops/azure-devops/build.sh'. (default: "https://raw.githubusercontent.com/Microsoft/bedrock/master/gitops/azure-devops/build.sh")
   -l, --packages-dir <packages-dir>                    The mono-repository directory containing this service definition. ie. '--packages-dir packages' if my-service is located under ./packages/my-service. Omitting this option implies this is a not a mono-repository.
+  --yaml-file-branch <yaml-file-branch>                The git branch where the pipeline definition yaml file is located. (default: "master")
   -h, --help                                           output usage information
 ```
 

src/commands/hld/pipeline.decorator.json

@@ -42,6 +42,12 @@
       "arg": "-b, --build-script-url <build-script-url>",
       "description": "Build Script URL. By default it is 'https://raw.githubusercontent.com/Microsoft/bedrock/master/gitops/azure-devops/build.sh'.",
       "defaultValue": "https://raw.githubusercontent.com/Microsoft/bedrock/master/gitops/azure-devops/build.sh"
+    },
+    {
+      "arg": "--yaml-file-branch <yaml-file-branch>",
+      "description": "The git branch where the pipeline definition yaml file is located.",
+      "required": false,
+      "defaultValue": "master"
     }
   ]
 }

src/commands/hld/pipeline.test.ts

@@ -30,7 +30,8 @@ const MOCKED_VALUES: ICommandOptions = {
   manifestUrl: "https://dev.azure.com/test/fabrikam/_git/materialized",
   orgName: "orgName",
   personalAccessToken: "personalAccessToken",
-  pipelineName: "pipelineName"
+  pipelineName: "pipelineName",
+  yamlFileBranch: "master"
 };
 
 const MOCKED_CONFIG = {
@@ -92,7 +93,8 @@ describe("test populateValues function", () => {
       manifestUrl: "",
       orgName: "",
       personalAccessToken: "",
-      pipelineName: ""
+      pipelineName: "",
+      yamlFileBranch: ""
     });
 
     expect(values.buildScriptUrl).toBe(BUILD_SCRIPT_URL);
@@ -113,6 +115,7 @@ describe("test populateValues function", () => {
         "-to-" +
         getRepositoryName(MOCKED_CONFIG.azure_devops.manifest_repository)
     );
+    expect(values.yamlFileBranch).toBe("");
   });
 });
 

src/commands/hld/pipeline.ts

@@ -30,6 +30,7 @@ export interface ICommandOptions {
   manifestUrl: string;
   devopsProject: string;
   buildScriptUrl: string;
+  yamlFileBranch: string;
 }
 
 export const emptyStringIfUndefined = (val: string | undefined) => {
@@ -132,7 +133,7 @@ export const installHldToManifestPipeline = async (values: ICommandOptions) => {
       values.buildScriptUrl,
       values.manifestUrl
     ),
-    yamlFileBranch: "master",
+    yamlFileBranch: values.yamlFileBranch,
     yamlFilePath: RENDER_HLD_PIPELINE_FILENAME
   } as IAzureRepoPipelineConfig);
 

src/commands/project/pipeline.decorator.json

@@ -37,6 +37,12 @@
       "arg": "-b, --build-script-url <build-script-url>",
       "description": "Build Script URL. By default it is https://raw.githubusercontent.com/Microsoft/bedrock/master/gitops/azure-devops/build.sh.",
       "required": true
+    },
+    {
+      "arg": "--yaml-file-branch <yaml-file-branch>",
+      "description": "The git branch where the pipeline definition yaml file is located.",
+      "required": false,
+      "defaultValue": "master"
     }
   ]
 }

src/commands/project/pipeline.test.ts

@@ -32,7 +32,8 @@ const mockValues: ICommandOptions = {
   personalAccessToken: "PAT",
   pipelineName: "pipelineName",
   repoName: "repoName",
-  repoUrl: "repoUrl"
+  repoUrl: "repoUrl",
+  yamlFileBranch: "master"
 };
 
 const mockMissingValues: ICommandOptions = {
@@ -42,7 +43,8 @@ const mockMissingValues: ICommandOptions = {
   personalAccessToken: undefined,
   pipelineName: undefined,
   repoName: undefined,
-  repoUrl: undefined
+  repoUrl: undefined,
+  yamlFileBranch: ""
 };
 
 const gitUrl = "https://github.com/CatalystCode/spk.git";

src/commands/project/pipeline.ts

@@ -40,6 +40,7 @@ export interface ICommandOptions {
   repoName: string | undefined;
   repoUrl: string | undefined;
   buildScriptUrl: string | undefined;
+  yamlFileBranch: string;
 }
 
 export const checkDependencies = (projectPath: string) => {
@@ -78,7 +79,8 @@ export const fetchValidateValues = (
     pipelineName:
       opts.pipelineName || getRepositoryName(gitOriginUrl) + "-lifecycle",
     repoName: opts.repoName || getRepositoryName(gitOriginUrl),
-    repoUrl: opts.repoUrl || getRepositoryUrl(gitOriginUrl)
+    repoUrl: opts.repoUrl || getRepositoryUrl(gitOriginUrl),
+    yamlFileBranch: opts.yamlFileBranch
   };
 
   const map: { [key: string]: string | undefined } = {};
@@ -146,7 +148,8 @@ export const commandDecorator = (command: commander.Command) => {
 
 const createPipeline = async (
   values: ICommandOptions,
-  devopsClient: IBuildApi
+  devopsClient: IBuildApi,
+  definitionBranch: string
 ): Promise<BuildDefinition> => {
   const definition = definitionForAzureRepoPipeline({
     branchFilters: ["master"], // hld reconcile pipeline is triggered only by merges into the master branch.
@@ -155,7 +158,7 @@ const createPipeline = async (
     repositoryName: values.repoName!,
     repositoryUrl: values.repoUrl!,
     variables: requiredPipelineVariables(values.buildScriptUrl!),
-    yamlFileBranch: "master", // Pipeline is defined in master
+    yamlFileBranch: definitionBranch, // Pipeline is defined in master
     yamlFilePath: PROJECT_PIPELINE_FILENAME // Pipeline definition lives in root directory.
   });
 
@@ -186,7 +189,11 @@ export const installLifecyclePipeline = async (values: ICommandOptions) => {
   );
   logger.info("Fetched DevOps Client");
 
-  const pipeline = await createPipeline(values, devopsClient);
+  const pipeline = await createPipeline(
+    values,
+    devopsClient,
+    values.yamlFileBranch
+  );
   if (typeof pipeline.id === "undefined") {
     const builtDefnString = JSON.stringify(pipeline);
     throw Error(

src/commands/service/pipeline.decorator.json

@@ -41,6 +41,12 @@
     {
       "arg": "-l, --packages-dir <packages-dir>",
       "description": "The mono-repository directory containing this service definition. ie. '--packages-dir packages' if my-service is located under ./packages/my-service. Omitting this option implies this is a not a mono-repository."
+    },
+    {
+      "arg": "--yaml-file-branch <yaml-file-branch>",
+      "description": "The git branch where the pipeline definition yaml file is located.",
+      "required": false,
+      "defaultValue": "master"
     }
   ]
 }