Add make_latest property to the GH release POST request during publish

lib/is-latest-release.js

@@ -0,0 +1,3 @@
+export default function isLatestRelease({ type, main }) {
+  return type === "release" && main ? "true" : "false";
+}

lib/publish.js

@@ -11,6 +11,7 @@ import globAssets from "./glob-assets.js";
 import resolveConfig from "./resolve-config.js";
 import { toOctokitOptions } from "./octokit.js";
 import isPrerelease from "./is-prerelease.js";
+import isLatestRelease from "./is-latest-release.js";
 
 const debug = debugFactory("semantic-release:github");
 
@@ -52,6 +53,7 @@ export default async function publish(pluginConfig, context, { Octokit }) {
     name: template(releaseNameTemplate)(context),
     body: template(releaseBodyTemplate)(context),
     prerelease: isPrerelease(branch),
+    make_latest: isLatestRelease(branch),
   };
 
   debug("release object: %O", release);

test/is-latest-release.test.js

@@ -0,0 +1,39 @@
+import test from "ava";
+import isLatestRelease from "../lib/is-latest-release.js";
+
+test("Test for empty object", (t) => {
+  const branch = {};
+  t.is(isLatestRelease(branch), "false");
+});
+
+test("Test if type release and main is used correctly", (t) => {
+  const branch = {
+    type: "release",
+    main: true,
+  };
+  t.is(isLatestRelease(branch), "true");
+});
+
+test("Test if type prerelease is used correctly", (t) => {
+  const branch = {
+    type: "prerelease",
+    main: true,
+  };
+  t.is(isLatestRelease(branch), "false");
+});
+
+test("Test if type main property as boolean is used correctly", (t) => {
+  const branch = {
+    type: "release",
+    main: false,
+  };
+  t.is(isLatestRelease(branch), "false");
+});
+
+test("Test maintenance branch returns false", (t) => {
+  const branch = {
+    type: "maintenance",
+    main: false,
+  };
+  t.is(isLatestRelease(branch), "false");
+});

test/publish.test.js

@@ -53,6 +53,7 @@ test("Publish a release without creating discussion", async (t) => {
         name: nextRelease.name,
         body: nextRelease.notes,
         prerelease: false,
+        make_latest: "true",
       },
     },
   );
@@ -117,6 +118,7 @@ test("Publish a release and create discussion", async (t) => {
         name: nextRelease.name,
         body: nextRelease.notes,
         prerelease: false,
+        make_latest: "true",
         discussion_category_name: pluginConfig.discussionCategoryName,
       },
     },
@@ -182,6 +184,7 @@ test("Publish a release on a channel", async (t) => {
         name: nextRelease.name,
         body: nextRelease.notes,
         prerelease: true,
+        make_latest: "false",
       },
     },
   );
@@ -212,7 +215,7 @@ test("Publish a release on a channel", async (t) => {
   t.true(fetch.done());
 });
 
-test("Publish a prerelease wihtout creating discussion", async (t) => {
+test("Publish a prerelease without creating discussion", async (t) => {
   const owner = "test_user";
   const repo = "test_repo";
   const env = { GITHUB_TOKEN: "github_token" };
@@ -242,6 +245,7 @@ test("Publish a prerelease wihtout creating discussion", async (t) => {
         name: nextRelease.name,
         body: nextRelease.notes,
         prerelease: true,
+        make_latest: "false",
       },
     },
   );
@@ -305,6 +309,7 @@ test("Publish a prerelease and create discussion", async (t) => {
         name: nextRelease.name,
         body: nextRelease.notes,
         prerelease: true,
+        make_latest: "false",
         discussion_category_name: pluginConfig.discussionCategoryName,
       },
     },
@@ -371,6 +376,7 @@ test("Publish a maintenance release", async (t) => {
         name: nextRelease.name,
         body: nextRelease.notes,
         prerelease: false,
+        make_latest: "false",
       },
     },
   );
@@ -448,6 +454,7 @@ test("Publish a release with one asset", async (t) => {
           body: nextRelease.notes,
           draft: true,
           prerelease: false,
+          make_latest: "true",
         },
       },
     )
@@ -535,6 +542,7 @@ test("Publish a release with one asset and custom github url", async (t) => {
           body: nextRelease.notes,
           draft: true,
           prerelease: false,
+          make_latest: "true",
         },
       },
     )
@@ -616,6 +624,7 @@ test("Publish a release with an array of missing assets", async (t) => {
           body: nextRelease.notes,
           draft: true,
           prerelease: false,
+          make_latest: "true",
         },
       },
     )
@@ -705,6 +714,7 @@ test("Publish a release with asset and create discussion", async (t) => {
           body: nextRelease.notes,
           draft: true,
           prerelease: false,
+          make_latest: "true",
         },
       },
     )
@@ -790,6 +800,7 @@ test("Publish a draft release", async (t) => {
         body: nextRelease.notes,
         draft: true,
         prerelease: false,
+        make_latest: "true",
       },
     },
   );
@@ -862,6 +873,7 @@ test("Publish a draft release with one asset", async (t) => {
           body: nextRelease.notes,
           draft: true,
           prerelease: false,
+          make_latest: "true",
         },
       },
     )
@@ -934,6 +946,7 @@ test("Publish a release when env.GITHUB_URL is set to https://github.com (Defaul
         name: nextRelease.name,
         body: nextRelease.notes,
         prerelease: false,
+        make_latest: "true",
       },
     },
   );
@@ -997,6 +1010,7 @@ test("Publish a custom release body", async (t) => {
         name: nextRelease.name,
         body: `To install this run npm install package@${nextRelease.name}\n\n${nextRelease.notes}`,
         prerelease: false,
+        make_latest: "true",
       },
     },
   );
@@ -1060,6 +1074,7 @@ test("Publish a custom release name", async (t) => {
         name: `omg its the best release: ${nextRelease.name} 🌈🌈`,
         body: nextRelease.notes,
         prerelease: false,
+        make_latest: "true",
       },
     },
   );