Cuts over to main in build configuration & docs (#2726)

gingi · web-flow · commit 95d91b4039e4 · 2023-05-09T18:08:36.000Z
Should allow new release builds to be created from `main`. Also updates docs and scripts to refer to the main branch.
diff --git a/.vsts/common/build-vars.ps1 b/.vsts/common/build-vars.ps1
@@ -10,35 +10,16 @@ $distTag = "latest"
 
 Write-Host "Branch is $branch"
 
-If ($branch -like "refs/heads/master") {
+If ($branch -like "refs/heads/main") {
     $buildType = "insider"
-    $distTag = "latest"
+    $distTag = "insider"
 }
 
 If ($branch -like "refs/heads/stable") {
     $buildType = "stable"
     $distTag = "stable"
 }
 
-If ($branch -like "refs/heads/vnext") {
-    $buildType = "vnext"
-    $distTag = "next"
-}
-
-# TEMPORARY (2023-02-09): This is to support the transition from vnext to main.
-# Eventually, the distribution pipeline on the main branch will create:
-#
-# - A BatchExplorer insider build (buildType = "insider")
-# - NPM packages with the latest tag (distTag = "latest")
-#
-# In the next phase, the `vnext` branch will be removed and the above condition
-# can be removed as well. In a subsequent phase, the `master` branch will be
-# deprecated, at which point the `master` condition above will also be removed.
-If ($branch -like "refs/heads/main") {
-    $buildType = "vnext"
-    $distTag = "next"
-}
-
 # Change to curent branch for testing
 If ($branch -like "refs/heads/feature/signing-vsts") {
     $buildType = "testing"
diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md
@@ -4,7 +4,7 @@
 
 ## Pull request message format
 
-Use a good description for the title(i.e. not just `Merge feature/awesome-stuff in master`)
+Use a good description for the title(i.e. not just `Merge feature/awesome-stuff in main`)
 If applicable please use the `fix #[issue number]` in the pull request description
 
 e.g.
diff --git a/Readme.md b/Readme.md
@@ -1,7 +1,7 @@
 # BatchExplorer
 
 [![VSTS Build Status](https://dev.azure.com/azurebatch/BatchExplorer/_apis/build/status/BatchExplorer%20-%20CI)](https://dev.azure.com/azurebatch/BatchExplorer/_build/latest?definitionId=8)
-[![codecov](https://codecov.io/gh/Azure/BatchExplorer/branch/master/graph/badge.svg)](https://codecov.io/gh/Azure/BatchExplorer)
+[![codecov](https://codecov.io/gh/Azure/BatchExplorer/branch/main/graph/badge.svg)](https://codecov.io/gh/Azure/BatchExplorer)
 
 Batch Explorer is a tool to manage your Azure Batch accounts. The goal is to implement a great user experience that will help you debug, monitor and manage your pools, jobs and tasks.
 It will also include experimental features such as `Batch Templates` in the aim to improve your Batch experience. We are open to any feedback, ideas and contributions you might have.
diff --git a/desktop/scripts/azpipelines/utils.ts b/desktop/scripts/azpipelines/utils.ts
@@ -27,8 +27,6 @@ export function getContainerName(buildType: string): string {
             return "stable";
         case "insider":
             return "insider";
-        case "vnext": // See comment in .vsts/common/build-vars.ps1
-            return "vnext";
         default:
             return "test";
     }
diff --git a/desktop/scripts/install/install-windows.ps1 b/desktop/scripts/install/install-windows.ps1
@@ -52,8 +52,8 @@ function confirm-branch() {
 
     if($current_branch -eq "stable") {
         add-success "Building from stable branch."
-    } elseif ($current_branch -eq "master") {
-        add-success "Building from master branch."
+    } elseif ($current_branch -eq "main") {
+        add-success "Building from main branch."
     } else {
         add-warning "Building from $current_branch branch it might not be stable."
     }
diff --git a/desktop/scripts/package/package-utils.ts b/desktop/scripts/package/package-utils.ts
@@ -13,11 +13,8 @@ export enum BuildType {
     Dev = "dev",
     // Official build release
     Stable = "stable",
-    // Build off master
-    Insider = "insider",
-    // Temporary until shared-libraries are merged
-    // (see comment in .vsts/common/build-vars.ps1)
-    Vnext = "vnext"
+    // Build off main branch
+    Insider = "insider"
 }
 
 export const version = computeVersion();
diff --git a/desktop/scripts/proxy/proxy-server.bicep b/desktop/scripts/proxy/proxy-server.bicep
@@ -96,7 +96,7 @@ resource proxyServerExtensions 'Microsoft.Compute/virtualMachines/extensions@201
     protectedSettings: {
       commandToExecute: 'sh initProxyServer.sh ${proxyPort}'
       fileUris: [
-        'https://raw.githubusercontent.com/Azure/BatchExplorer/master/scripts/proxy/initProxyServer.sh'
+        'https://raw.githubusercontent.com/Azure/BatchExplorer/main/scripts/proxy/initProxyServer.sh'
       ]
     }
   }
diff --git a/desktop/scripts/proxy/virtual-machine.bicep b/desktop/scripts/proxy/virtual-machine.bicep
@@ -86,7 +86,7 @@ resource windowsVMExtensions 'Microsoft.Compute/virtualMachines/extensions@2020-
     autoUpgradeMinorVersion: true
     protectedSettings: {
       fileUris: [
-        'https://raw.githubusercontent.com/Azure/BatchExplorer/master/scripts/proxy/initVirtualMachine.ps1'
+        'https://raw.githubusercontent.com/Azure/BatchExplorer/main/scripts/proxy/initVirtualMachine.ps1'
       ]
       commandToExecute: 'powershell -ExecutionPolicy Bypass -File initVirtualMachine.ps1 -Address ${proxyServer} -Port ${proxyPort} -Build ${batchExplorerBuild}'
     }
diff --git a/desktop/scripts/publish/github-api.ts b/desktop/scripts/publish/github-api.ts
@@ -37,12 +37,12 @@ export async function createIssue(repo: string, title: string, description: stri
     });
 }
 
-export async function listPullRequests(repo: string, source: string, target = "master"): Promise<Issue[]> {
+export async function listPullRequests(repo: string, source: string, target = "main"): Promise<Issue[]> {
     const url = `${pullRequestsUrl(repo)}?head=Azure:${source}&base=${target}`;
     return get(url);
 }
 
-export async function createPullRequest(repo: string, title: string, body: string, source: string, target = "master") {
+export async function createPullRequest(repo: string, title: string, body: string, source: string, target = "main") {
     return post(pullRequestsUrl(repo), {
         title,
         body,
diff --git a/desktop/scripts/publish/publish.ts b/desktop/scripts/publish/publish.ts
@@ -7,7 +7,7 @@ import {
     createIssue, createPullRequest, getMilestone, githubToken, listMilestoneIssues, listPullRequests,
 } from "./github-api";
 
-const MAIN_BRANCH = "master";
+const MAIN_BRANCH = "main";
 
 const root = path.resolve(path.join(__dirname, "../.."));
 const allMessages: string[] = [];
@@ -54,7 +54,7 @@ function checkGithubToken() {
 }
 
 /**
- * This goes back to master and pull
+ * This goes back to the main branch and pulls the latest
  */
 async function gotoMainBranch() {
     await run(`git checkout ${MAIN_BRANCH}`);
diff --git a/desktop/src/@batch-flask/ui/activity/activity.service.ts b/desktop/src/@batch-flask/ui/activity/activity.service.ts
@@ -28,9 +28,9 @@ export class ActivityService {
     }
 
     /**
-     * Loads a single activity into the master processor, and runs the processor
+     * Loads a single activity into the main processor, and runs the processor
      * N.B. this method is cascadable, in case it needs to be chained with done()
-     * @param activity the activity to load into the master processor
+     * @param activity the activity to load into the main processor
      */
     public exec(activity: Activity): ActivityService {
         this.processor.exec([activity]);
@@ -46,7 +46,7 @@ export class ActivityService {
     }
 
     /**
-     * Reruns the given activity by creating a clone of it and reexecuting it on the master processor
+     * Reruns the given activity by creating a clone of it and reexecuting it on the main processor
      * @param activity the activity to rerun
      */
     public rerun(activity: Activity): void {
diff --git a/desktop/src/app/services/ncj/portfolio/github-portfolio.spec.ts b/desktop/src/app/services/ncj/portfolio/github-portfolio.spec.ts
@@ -21,7 +21,7 @@ describe("GithubPortfolio", () => {
             unzip: jasmine.createSpy("download").and.callFake(() => Promise.resolve()),
             saveFile: jasmine.createSpy("saveFile").and.callFake(() => Promise.resolve()),
             readFile: jasmine.createSpy("readFile").and.callFake(() => Promise.resolve(JSON.stringify({
-                lastSync: lastSyncDate, source: "https://github.com/my/portfolio/archive/master.zip",
+                lastSync: lastSyncDate, source: "https://github.com/my/portfolio/archive/main.zip",
             }))),
         };
 
@@ -30,7 +30,7 @@ describe("GithubPortfolio", () => {
     function setup() {
         portfolio = new GithubPortfolio({
             id: "my-portfolio-1",
-            source: "https://github/my/portfolio/tree/master",
+            source: "https://github/my/portfolio/tree/main",
             path: "templates",
             type: PortfolioType.Github,
         }, fsSpy);
@@ -69,7 +69,7 @@ describe("GithubPortfolio", () => {
         const zipPath = path.join("~/temp/portfolios/zips/my-portfolio-1.zip");
         expect(fsSpy.download).toHaveBeenCalledOnce();
         expect(fsSpy.download).toHaveBeenCalledWith(
-            "https://github.com/my/portfolio/archive/master.zip",
+            "https://github.com/my/portfolio/archive/main.zip",
             zipPath,
         );
 
@@ -80,7 +80,7 @@ describe("GithubPortfolio", () => {
 
         expect(fsSpy.saveFile).toHaveBeenCalledOnce();
         expect(fsSpy.saveFile).toHaveBeenCalledWith(path.join("~/temp/portfolios/my-portfolio-1/sync.json"),
-            jasmine.stringMatching(`{"source":"https://github.com/my/portfolio/archive/master.zip","lastSync":".*"}`));
+            jasmine.stringMatching(`{"source":"https://github.com/my/portfolio/archive/main.zip","lastSync":".*"}`));
     });
 
     it("cache the data when data is too old", async () => {
@@ -96,7 +96,7 @@ describe("GithubPortfolio", () => {
         const zipPath = path.join("~/temp/portfolios/zips/my-portfolio-1.zip");
         expect(fsSpy.download).toHaveBeenCalledOnce();
         expect(fsSpy.download).toHaveBeenCalledWith(
-            "https://github.com/my/portfolio/archive/master.zip",
+            "https://github.com/my/portfolio/archive/main.zip",
             zipPath,
         );
 
@@ -107,7 +107,7 @@ describe("GithubPortfolio", () => {
 
         expect(fsSpy.saveFile).toHaveBeenCalledOnce();
         expect(fsSpy.saveFile).toHaveBeenCalledWith(path.join("~/temp/portfolios/my-portfolio-1/sync.json"),
-            jasmine.stringMatching(`{"source":"https://github.com/my/portfolio/archive/master.zip","lastSync":".*"}`));
+            jasmine.stringMatching(`{"source":"https://github.com/my/portfolio/archive/main.zip","lastSync":".*"}`));
     });
 
     it("doesn't do anything if data is newer", async () => {
@@ -143,7 +143,7 @@ describe("GithubPortfolio", () => {
         const zipPath = path.join("~/temp/portfolios/zips/my-portfolio-1.zip");
         expect(fsSpy.download).toHaveBeenCalledOnce();
         expect(fsSpy.download).toHaveBeenCalledWith(
-            "https://github.com/my/portfolio/archive/master.zip",
+            "https://github.com/my/portfolio/archive/main.zip",
             zipPath,
         );
 
@@ -154,6 +154,6 @@ describe("GithubPortfolio", () => {
 
         expect(fsSpy.saveFile).toHaveBeenCalledOnce();
         expect(fsSpy.saveFile).toHaveBeenCalledWith(path.join("~/temp/portfolios/my-portfolio-1/sync.json"),
-            jasmine.stringMatching(`{"source":"https://github.com/my/portfolio/archive/master.zip","lastSync":".*"}`));
+            jasmine.stringMatching(`{"source":"https://github.com/my/portfolio/archive/main.zip","lastSync":".*"}`));
     });
 });
diff --git a/docs/new-release.md b/docs/new-release.md
@@ -1,119 +1,3 @@
-# New release
+# Making a New Release
 
-There is 2 types of releases:
-
-* **Major releases**: This is for a release that contains new features
-* **Hot fix releases**: This should **ONLY** be for patching major bugs that prevent usage
-
-## Major release process
-
-This is the steps to create a major release
-
-### Prerequistie: Millestone
-
-Every release should have a millestone with the list of issues fixed in that new version.
-
-You can use the command `npm run publish -- <millestoneid>` to do step 1&2 and skip to step 3
-
-### Step 1: Create a release issue
-
-Create a new issue in the millestone with the title `Prepare version x.y.z` and the following description:
-
-```md
-- [ ] Update version in package.json
-- [ ] Update changelog
-- [ ] Update third party notices if needed
-- [ ] Double check the prod build is working
-```
-
-This will help with tracking the required task for a new release.
-
-### Step 2: Update repo
-
-Create a branch called `release/prepare-<milestone>`, i.e. `release/prepare-0.10.0`
-
-#### Update version in package.json
-
-This is quite straightforward. Just change the following line to have the version wanted
-
-```json
-{
-    ...
-    "version": "0.2.0",
-    ...
-}
-```
-
-#### Update the changelog
-
-This is a bit more tedious as it require looking at the millestone completed and writing a reable changelog for the user of Batch Explorer.
-This should be targeted at user and not developper which means there is no need to include internal issues and refactoring work.
-Describe what functionality changed in the app with a link to the issue.
-
-Example:
-
-```md
-* Added this awesome thing in the pool details [\#123](https://github.com/Azure/BatchExplorer/issues/123)
-```
-
-**Note:** There is now a utility to generate the change log for a millestone also so you don't have to write it manually.
-[https://www.npmjs.com/package/github-changelog-gen](https://www.npmjs.com/package/github-changelog-gen)
-
-#### Update third party notices
-
-Running the following command will update any required third party notices.
-
-```shell
-npm run ts scripts/lca/generate-third-party
-```
-
-**Important:** Make sure you have an environment variable called GH_TOKEN set that contains a valid GitHub API auth token.
-You can manage and setup personal access tokens here: [https://github.com/settings/tokens](https://github.com/settings/tokens)
-
-If you see an error like the following while executing the 'generate-third-party' script:
-
-```shell
-const value = match[1];
-                    ^
-TypeError: Cannot read property '1' of null
-```
-
-This probably means that a dependancy in package.json has a differnt format to what we are expecting.
-You will need to modify '\scripts\lca\generate-third-party.ts' in order to get it to work.
-
-#### Double check the prod build is working
-
-CI should check on master that the build itself it not failing. However there could still be runtime errors that happens.
-Do the following and test the application.
-
-```shell
-npm run build:package
-```
-
-### Step: 3 Merge those changes
-
-Create a PR against master with the changelog, package.json changes and reference the issue created in step 1(.i.e fix \#123).
-
-### Step 4: Create a PR against stable
-
-Now create a pull request against stable. Wait for the CI to pass.
-
-**Important:** DO NOT squash merge the changes.(Go in BatchExplorer [settings](https://github.com/Azure/BatchExplorer/settings) and renenable "Allow merge commits")
-Then click on merge commit(Make sure it is not squash merge)
-
-![Merge commit](images/merge-commit.png)
-
-All the commits in master should now be in stable with the merge commit.
-Now disable the "Allow merge commit" again to prevent mistake when merging to master.
-
-## Hot fix release
-
-For a hot fix release you'll want to create a PR with your fix directly against `stable`.
-In your changes include the bump of the patch in the version if needs be(Only increase once if you have multiple hot fixes in different PR)
-Update `Changelog.md` with the list of the fixes.
-
-When ready squash merge your PR in stable.
-
-## Deploy the release
-
-Check the wiki in msazure VSTS <https://msazure.visualstudio.com/AzureBatch/_wiki/wikis/AzureBatch.wiki?wikiVersion=GBwikiMaster&pagePath=%2FBatch%20Explorer%2FDeploy%20new%20version%20of%20Batch%20Explorer>
+Please refer to [the release documentation](https://msazure.visualstudio.com/AzureBatch/_wiki/wikis/AzureBatch.wiki?wikiVersion=GBwikiMaster&pagePath=%2FBatch%20Explorer%2FDeploy%20new%20version%20of%20Batch%20Explorer) on the Azure DevOps wiki.
diff --git a/docs/readme.md b/docs/readme.md
@@ -24,5 +24,5 @@
 
 ## Repo management
 
-* [Make a new release](new-release.md)
+* [Make a new release (Wiki)](https://msazure.visualstudio.com/AzureBatch/_wiki/wikis/AzureBatch.wiki?wikiVersion=GBwikiMaster&pagePath=%2FBatch%20Explorer%2FDeploy%20new%20version%20of%20Batch%20Explorer)
 * [Third party dependencies](third-party-dependencies.md)

Original file line number	Diff line number	Diff line change
`@@ -27,8 +27,6 @@ export function getContainerName(buildType: string): string {`
`27`	`27`	`return "stable";`
`28`	`28`	`case "insider":`
`29`	`29`	`return "insider";`
`30`		`- case "vnext": // See comment in .vsts/common/build-vars.ps1`
`31`		`- return "vnext";`
`32`	`30`	`default:`
`33`	`31`	`return "test";`
`34`	`32`	`}`
Original file line number	Diff line number	Diff line change
`@@ -96,7 +96,7 @@ resource proxyServerExtensions 'Microsoft.Compute/virtualMachines/extensions@201`
`96`	`96`	`protectedSettings: {`
`97`	`97`	`commandToExecute: 'sh initProxyServer.sh ${proxyPort}'`
`98`	`98`	`fileUris: [`
`99`		`- 'https://raw.githubusercontent.com/Azure/BatchExplorer/master/scripts/proxy/initProxyServer.sh'`
	`99`	`+ 'https://raw.githubusercontent.com/Azure/BatchExplorer/main/scripts/proxy/initProxyServer.sh'`
`100`	`100`	`]`
`101`	`101`	`}`
`102`	`102`	`}`
Original file line number	Diff line number	Diff line change
`@@ -86,7 +86,7 @@ resource windowsVMExtensions 'Microsoft.Compute/virtualMachines/extensions@2020-`
`86`	`86`	`autoUpgradeMinorVersion: true`
`87`	`87`	`protectedSettings: {`
`88`	`88`	`fileUris: [`
`89`		`- 'https://raw.githubusercontent.com/Azure/BatchExplorer/master/scripts/proxy/initVirtualMachine.ps1'`
	`89`	`+ 'https://raw.githubusercontent.com/Azure/BatchExplorer/main/scripts/proxy/initVirtualMachine.ps1'`
`90`	`90`	`]`
`91`	`91`	`commandToExecute: 'powershell -ExecutionPolicy Bypass -File initVirtualMachine.ps1 -Address ${proxyServer} -Port ${proxyPort} -Build ${batchExplorerBuild}'`
`92`	`92`	`}`
Original file line number	Diff line number	Diff line change
`@@ -37,12 +37,12 @@ export async function createIssue(repo: string, title: string, description: stri`
`37`	`37`	`});`
`38`	`38`	`}`
`39`	`39`
`40`		`-export async function listPullRequests(repo: string, source: string, target = "master"): Promise<Issue[]> {`
	`40`	`+export async function listPullRequests(repo: string, source: string, target = "main"): Promise<Issue[]> {`
`41`	`41`	const url = `${pullRequestsUrl(repo)}?head=Azure:${source}&base=${target}`;
`42`	`42`	`return get(url);`
`43`	`43`	`}`
`44`	`44`
`45`		`-export async function createPullRequest(repo: string, title: string, body: string, source: string, target = "master") {`
	`45`	`+export async function createPullRequest(repo: string, title: string, body: string, source: string, target = "main") {`
`46`	`46`	`return post(pullRequestsUrl(repo), {`
`47`	`47`	`title,`
`48`	`48`	`body,`