fix(build-cli): Allow prerelease as a valid value for release argument (

#12479) This bug was found when trying to publish a prerelease from the lts branch. The change is trivial and includes some test cases.
microsoft · Oct 13, 2022 · 0dc04f0 · 0dc04f0
1 parent 6bceb77
commit 0dc04f0
Show file tree

Hide file tree

Showing 3 changed files with 76 additions and 8 deletions.
diff --git a/build-tools/packages/build-cli/docs/generate.md b/build-tools/packages/build-cli/docs/generate.md
@@ -14,8 +14,8 @@ This command is used to compute the version number of Fluid packages. The releas
 
 ```
 USAGE
-  $ flub generate buildVersion --build <value> [--testBuild <value>] [--release release|none] [--patch <value>] [--base
-    <value>] [--tag <value>] [-i <value>] [-v]
+  $ flub generate buildVersion --build <value> [--testBuild <value>] [--release release|prerelease|none] [--patch <value>]
+    [--base <value>] [--tag <value>] [-i <value>] [-v]
 
 FLAGS
   -i, --includeInternalVersions=<value>  Include Fluid internal versions.
@@ -25,7 +25,7 @@ FLAGS
   --build=<value>                        (required) The CI build number.
   --patch=<value>                        Indicates the build is a patch build.
   --release=<option>                     Indicates the build is a release build.
-                                         <options: release|none>
+                                         <options: release|prerelease|none>
   --tag=<value>                          The tag name to use.
   --testBuild=<value>                    Indicates the build is a test build.
 

diff --git a/build-tools/packages/build-cli/src/commands/generate/buildVersion.ts b/build-tools/packages/build-cli/src/commands/generate/buildVersion.ts
@@ -34,7 +34,7 @@ export default class GenerateBuildVersionCommand extends BaseCommand<
         }),
         release: Flags.string({
             description: "Indicates the build is a release build.",
-            options: ["release", "none"],
+            options: ["release", "prerelease", "none"],
             env: "VERSION_RELEASE",
         }),
         patch: Flags.string({

diff --git a/build-tools/packages/build-cli/test/commands/generate/buildVersion.test.ts b/build-tools/packages/build-cli/test/commands/generate/buildVersion.test.ts
@@ -115,6 +115,25 @@ describe("generate:buildVersion", () => {
             expect(ctx.stdout).to.contain("isLatest=true");
         });
 
+    test.stdout()
+        .command([
+            "generate:buildVersion",
+            "--build",
+            "12345",
+            "--fileVersion",
+            "0.5.2002",
+            "--tag",
+            "build-tools",
+            "--release",
+            "prerelease",
+            "--tags",
+            ...test_tags,
+        ])
+        .it("outputs isLatest=false when release is prerelease", (ctx) => {
+            expect(ctx.stdout).to.contain("version=0.5.2002-12345");
+            expect(ctx.stdout).to.contain("isLatest=false");
+        });
+
     test.env({
         VERSION_RELEASE: "release",
     })
@@ -171,10 +190,13 @@ describe("generate:buildVersion", () => {
             "--tags",
             ...test_tags,
         ])
-        .it("calculates internal versions as latest", (ctx) => {
-            expect(ctx.stdout).to.contain("version=1.2.4");
-            expect(ctx.stdout).to.contain("isLatest=false");
-        });
+        .it(
+            "isLatest=false when including internal versions when determining what's latest",
+            (ctx) => {
+                expect(ctx.stdout).to.contain("version=1.2.4");
+                expect(ctx.stdout).to.contain("isLatest=false");
+            },
+        );
 
     test.env({
         VERSION_INCLUDE_INTERNAL_VERSIONS: "True",
@@ -276,4 +298,50 @@ describe("generate:buildVersion", () => {
             expect(ctx.stdout).to.contain("version=0.4.88879");
             expect(ctx.stdout).to.contain("isLatest=true");
         });
+
+    test.env({
+        VERSION_BUILDNUMBER: "100339",
+        VERSION_TAGNAME: "client",
+        TEST_BUILD: "false",
+        VERSION_RELEASE: "prerelease",
+        VERSION_INCLUDE_INTERNAL_VERSIONS: "False",
+    })
+        .stdout()
+        .command([
+            "generate:buildVersion",
+            "--fileVersion",
+            "1.3.0",
+            "--tags",
+            "client_v1.0.0",
+            "client_v1.0.1",
+            "client_v1.0.2",
+            "client_v1.1.0",
+            "client_v1.1.1",
+            "client_v1.1.2",
+            "client_v1.2.0",
+            "client_v1.2.1",
+            "client_v1.2.2",
+            "client_v1.2.3",
+            "client_v1.2.4",
+            "client_v1.2.5",
+            "client_v1.2.6",
+            "client_v1.2.7",
+            "client_v2.0.0-internal.1.0.0",
+            "client_v2.0.0-internal.1.0.1",
+            "client_v2.0.0-internal.1.1.0",
+            "client_v2.0.0-internal.1.1.1",
+            "client_v2.0.0-internal.1.1.2",
+            "client_v2.0.0-internal.1.1.3",
+            "client_v2.0.0-internal.1.1.4",
+            "client_v2.0.0-internal.1.2.0",
+            "client_v2.0.0-internal.1.2.1",
+            "client_v2.0.0-internal.1.2.2",
+            "client_v2.0.0-internal.1.4.0",
+            "client_v2.0.0-internal.1.4.1",
+            "client_v2.0.0-internal.1.4.2",
+        ])
+        .it("lts test case from 2022-10-13", (ctx) => {
+            expect(ctx.stdout).to.contain("version=1.3.0-100339");
+            expect(ctx.stdout).to.contain("isLatest=false");
+        });
 });