feat: add 'Full Changelog' links in releases description (#21)

* chore: bump deps * bump deps * feat: add 'Full Changelog' links in releases description * fix first commit
sylc · Feb 8, 2023 · 0897bac · 0897bac
1 parent c1aa5d0
commit 0897bac
Show file tree

Hide file tree

Showing 3 changed files with 17 additions and 4 deletions.
diff --git a/plugins/changelog/mod.ts b/plugins/changelog/mod.ts
@@ -27,13 +27,14 @@ const plugin: ReleasePlugin = {
 
     for (let i = 0; i < tags.length; i++) {
       const tag = tags[i];
+      const parent = i < tags.length - 1 ? tags[i + 1] : undefined;
       const belonging = commits.filter((_) => _.belongs?.hash === tag.hash);
       const filteredTypes = filters.map((f) => f.type);
       const filteredCommits = belonging.filter((_) =>
         filteredTypes.includes(_.cc.type || "")
       );
       if (filteredCommits.length) {
-        pushTag(doc, repo, belonging, filters, tag, "md");
+        pushTag(doc, repo, belonging, filters, tag, "md", parent);
       }
     }
 

diff --git a/plugins/github/mod.ts b/plugins/github/mod.ts
@@ -52,7 +52,8 @@ const plugin: ReleasePlugin<GithubConfig> = {
 
     const latest = tags[0];
     const belonging = commits.filter((_) => _.belongs?.hash === latest.hash);
-    pushTag(doc, repo, belonging, filters, latest, "github");
+    const parent = tags.length > 0 ? tags[1] : undefined;
+    pushTag(doc, repo, belonging, filters, latest, "github", parent);
 
     if (!config.options.dry) {
       const token = Deno.env.get(GITHUB_TOKEN)!;

diff --git a/src/changelog.ts b/src/changelog.ts
@@ -91,10 +91,9 @@ export function pushTag(
   if (repo.remote && repo.remote.github && style === "md") {
     const { user, name } = repo.remote.github;
     let url = `https://github.com/${user}/${name}/`;
-
     url = parent
       ? `${url}compare/${parent.version}...${tag.version}`
-      : `${url}compare/${tag.version}`;
+      : `${url}compare/${repo.commits.pop()?.hash}...${tag.version}`;
     doc.links.push(fmtLink(tag.version, url));
     doc.sections.push(`## [${tag.version}] - ${year}-${month}-${day}`);
   } else {
@@ -107,6 +106,14 @@ export function pushTag(
       pushChanges(doc, repo, filter.title, filtered, style);
     }
   }
+  if (repo.remote && repo.remote.github && parent) {
+    const linkName = `${parent.version}...${tag.version}`;
+    doc.sections.push(`Full Changelog: [${linkName}]`);
+    const { user, name } = repo.remote.github;
+    const url =
+      `https://github.com/${user}/${name}/compare/${parent.version}...${tag.version}`;
+    doc.links.push(fmtLink(linkName, url));
+  }
 }
 
 export function render(doc: Document): string {
@@ -116,6 +123,10 @@ export function render(doc: Document): string {
   return `${full.join("\n\n").trim()}\n`;
 }
 
+/**
+ * Add the new tag to the list of tags. beeing the latest it is the first one
+ * @returns array of tags and commits
+ */
 export function polyfillVersion(repo: Repo, to: string): [Tag[], Commit[]] {
   const newtag: Tag = {
     tag: to,