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/integration.test.js

@@ -187,6 +187,189 @@ test("Throw SemanticReleaseError if invalid config", async (t) => {
   t.is(errors[8].code, "ENOGHTOKEN");
 });
 
+test("Publish a release without assets on a main release branch", async (t) => {
+  const owner = "test_user";
+  const repo = "test_repo";
+  const env = { GITHUB_TOKEN: "github_token" };
+  const nextRelease = {
+    gitTag: "v1.0.0",
+    name: "v1.0.0",
+    notes: "Test release note body",
+  };
+  const options = { repositoryUrl: `https://github.com/${owner}/${repo}.git` };
+  const releaseUrl = `https://github.com/${owner}/${repo}/releases/${nextRelease.version}`;
+  const releaseId = 1;
+
+  const fetch = fetchMock
+    .sandbox()
+    .getOnce(`https://api.github.local/repos/${owner}/${repo}`, {
+      permissions: {
+        push: true,
+      },
+      clone_url: `https://api.github.local/${owner}/${repo}.git`,
+    })
+    .postOnce(
+      `https://api.github.local/repos/${owner}/${repo}/releases`,
+      { html_url: releaseUrl, id: releaseId },
+      {
+        body: {
+          tag_name: nextRelease.gitTag,
+          name: nextRelease.name,
+          body: nextRelease.notes,
+          prerelease: false,
+          make_latest: "true",
+        },
+      },
+    );
+
+  const result = await t.context.m.publish(
+    {},
+    {
+      cwd,
+      env,
+      options,
+      branch: { type: "release", main: true },
+      nextRelease,
+      logger: t.context.logger,
+    },
+    {
+      Octokit: TestOctokit.defaults((options) => ({
+        ...options,
+        request: { ...options.request, fetch },
+      })),
+    },
+  );
+
+  t.is(result.url, releaseUrl);
+  t.is(result.name, "GitHub release");
+  t.is(result.id, releaseId);
+  t.deepEqual(t.context.log.args[0], ["Verify GitHub authentication"]);
+  t.true(t.context.log.calledWith("Published GitHub release: %s", releaseUrl));
+  t.true(fetch.done());
+});
+
+test("Publish a release without assets on a non-main release branch", async (t) => {
+  const owner = "test_user";
+  const repo = "test_repo";
+  const env = { GITHUB_TOKEN: "github_token" };
+  const nextRelease = {
+    gitTag: "v1.0.0",
+    name: "v1.0.0",
+    notes: "Test release note body",
+  };
+  const options = { repositoryUrl: `https://github.com/${owner}/${repo}.git` };
+  const releaseUrl = `https://github.com/${owner}/${repo}/releases/${nextRelease.version}`;
+  const releaseId = 1;
+
+  const fetch = fetchMock
+    .sandbox()
+    .getOnce(`https://api.github.local/repos/${owner}/${repo}`, {
+      permissions: {
+        push: true,
+      },
+      clone_url: `https://api.github.local/${owner}/${repo}.git`,
+    })
+    .postOnce(
+      `https://api.github.local/repos/${owner}/${repo}/releases`,
+      { html_url: releaseUrl, id: releaseId },
+      {
+        body: {
+          tag_name: nextRelease.gitTag,
+          name: nextRelease.name,
+          body: nextRelease.notes,
+          prerelease: true,
+          make_latest: "false",
+        },
+      },
+    );
+
+  const result = await t.context.m.publish(
+    {},
+    {
+      cwd,
+      env,
+      options,
+      branch: { type: "release" },
+      nextRelease,
+      logger: t.context.logger,
+    },
+    {
+      Octokit: TestOctokit.defaults((options) => ({
+        ...options,
+        request: { ...options.request, fetch },
+      })),
+    },
+  );
+
+  t.is(result.url, releaseUrl);
+  t.is(result.name, "GitHub release");
+  t.is(result.id, releaseId);
+  t.deepEqual(t.context.log.args[0], ["Verify GitHub authentication"]);
+  t.true(t.context.log.calledWith("Published GitHub release: %s", releaseUrl));
+  t.true(fetch.done());
+});
+
+test("Publish a release without assets on a maintenance branch", async (t) => {
+  const owner = "test_user";
+  const repo = "test_repo";
+  const env = { GITHUB_TOKEN: "github_token" };
+  const nextRelease = {
+    gitTag: "v1.0.0",
+    name: "v1.0.0",
+    notes: "Test release note body",
+  };
+  const options = { repositoryUrl: `https://github.com/${owner}/${repo}.git` };
+  const releaseUrl = `https://github.com/${owner}/${repo}/releases/${nextRelease.version}`;
+  const releaseId = 1;
+
+  const fetch = fetchMock
+    .sandbox()
+    .getOnce(`https://api.github.local/repos/${owner}/${repo}`, {
+      permissions: {
+        push: true,
+      },
+      clone_url: `https://api.github.local/${owner}/${repo}.git`,
+    })
+    .postOnce(
+      `https://api.github.local/repos/${owner}/${repo}/releases`,
+      { html_url: releaseUrl, id: releaseId },
+      {
+        body: {
+          tag_name: nextRelease.gitTag,
+          name: nextRelease.name,
+          body: nextRelease.notes,
+          prerelease: false,
+          make_latest: "false",
+        },
+      },
+    );
+
+  const result = await t.context.m.publish(
+    {},
+    {
+      cwd,
+      env,
+      options,
+      branch: { type: "maintenance" },
+      nextRelease,
+      logger: t.context.logger,
+    },
+    {
+      Octokit: TestOctokit.defaults((options) => ({
+        ...options,
+        request: { ...options.request, fetch },
+      })),
+    },
+  );
+
+  t.is(result.url, releaseUrl);
+  t.is(result.name, "GitHub release");
+  t.is(result.id, releaseId);
+  t.deepEqual(t.context.log.args[0], ["Verify GitHub authentication"]);
+  t.true(t.context.log.calledWith("Published GitHub release: %s", releaseUrl));
+  t.true(fetch.done());
+});
+
 test("Publish a release with an array of assets", async (t) => {
   const owner = "test_user";
   const repo = "test_repo";
@@ -227,6 +410,7 @@ test("Publish a release with an array of assets", async (t) => {
           body: nextRelease.notes,
           draft: true,
           prerelease: false,
+          make_latest: "true",
         },
       },
     )
@@ -322,6 +506,7 @@ test("Publish a release with release information in assets", async (t) => {
           body: nextRelease.notes,
           draft: true,
           prerelease: true,
+          make_latest: "false",
         },
       },
     )
@@ -718,6 +903,7 @@ test("Verify, release and notify success", async (t) => {
           body: nextRelease.notes,
           draft: true,
           prerelease: false,
+          make_latest: "true",
         },
       },
     )

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");
+});