feat: Include GitHub compare link in the changelog (#48)

* feat: Include GitHub compare link in the changelog * fix: Full Changelog link markdown position
ardalanamini · Apr 29, 2022 · a4aa721 · a4aa721
1 parent 4f2084e
commit a4aa721
Show file tree

Hide file tree

Showing 5 changed files with 22 additions and 13 deletions.
diff --git a/action/index.js b/action/index.js
diff --git a/action/index.js.map b/action/index.js.map
diff --git a/src/constants.ts b/src/constants.ts
@@ -29,6 +29,11 @@ export interface TagInputI {
   prerelease: boolean;
 }
 
+export interface TagResultI {
+  sha?: string;
+  name?: string;
+}
+
 export interface ChangelogInputI {
   octokit: InstanceType<typeof GitHub>;
   owner: string;

diff --git a/src/index.ts b/src/index.ts
@@ -30,7 +30,7 @@ async function run() {
 
   if (semver != null) prerelease = semver.prerelease.length > 0;
 
-  const tagRef = await getTagSha({
+  const { sha: tagRef, name: tagName } = await getTagSha({
     octokit,
     owner,
     repo,
@@ -39,7 +39,7 @@ async function run() {
     prerelease,
   });
 
-  const changelog = await generate({
+  let changelog = await generate({
     octokit,
     owner,
     repo,
@@ -48,13 +48,17 @@ async function run() {
     inputs,
   });
 
-  info(changelog);
-
-  setOutput("changelog", changelog);
+  if (tagName != null) {
+    changelog += `\n\n**Full Changelog**: https://github.com/${owner}/${repo}/compare/${tagName}...${inputs.releaseName}`;
+  }
 
-  info(`prerelease: ${prerelease}`);
+  info(`-> prerelease: ${prerelease}`);
 
   setOutput("prerelease", prerelease);
+
+  info(`-> changelog: "${changelog}"`);
+
+  setOutput("changelog", changelog);
 }
 
 run().catch(setFailed);
diff --git a/src/tag.ts b/src/tag.ts
@@ -1,7 +1,7 @@
 import SemVer from "semver";
-import { TagInputI } from "./constants.js";
+import type { TagInputI, TagResultI } from "./constants.js";
 
-export async function getTagSha(input: TagInputI): Promise<string | undefined> {
+export async function getTagSha(input: TagInputI): Promise<TagResultI> {
   const { octokit, owner, repo, sha, semver, prerelease } = input;
 
   for await (const { data } of octokit.paginate.iterator(
@@ -18,17 +18,17 @@ export async function getTagSha(input: TagInputI): Promise<string | undefined> {
     } of data) {
       if (sha === tagSha) continue;
 
-      if (semver == null) return tagSha;
+      if (semver == null) return { sha: tagSha, name };
 
       const tagSemver = SemVer.parse(name, { includePrerelease: true });
 
       if (tagSemver == null || semver.compare(tagSemver) <= 0) continue;
 
       if (tagSemver.prerelease.length > 0 && !prerelease) continue;
 
-      return tagSha;
+      return { sha: tagSha, name };
     }
   }
 
-  return undefined;
+  return {};
 }