feat: add include-commit-links & include-pr-links action inputs (#136)

Author: ardalanamini

README.md

@@ -149,6 +149,30 @@ _Default:_
 true
 ```
 
+#### `include-pr-links`
+
+**(Optional)**
+
+Include GitHub pull request links at each log if applicable.
+
+_Default:_
+
+```yaml
+true
+```
+
+#### `include-commit-links`
+
+**(Optional)**
+
+Include GitHub commit links at each log.
+
+_Default:_
+
+```yaml
+true
+```
+
 #### `semver`
 
 **(Optional)**
@@ -225,5 +249,7 @@ Using with custom inputs:
     mention-authors: true
     mention-new-contributors: true
     include-compare: true
+    include-pr-lints: true
+    include-commit-lints: true
     semver: true
 ```

action.yml

@@ -59,6 +59,16 @@ inputs:
     required: true
     default: 'true'
 
+  include-pr-links:
+    description: Include GitHub pull request links at each log if applicable
+    required: true
+    default: 'true'
+
+  include-commit-links:
+    description: Include GitHub commit links at each log
+    required: true
+    default: 'true'
+
   semver:
     description: Enable semver based version comparison
     required: true

action/index.js

@@ -20,7 +20,7 @@ function unique(value: string[]): string[] {
 
 export async function generate(input: ChangelogInputI): Promise<string> {
   const { octokit, owner, repo, sha, tagRef, inputs } = input;
-  const { commitTypes, defaultCommitType, mentionAuthors } = inputs;
+  const { commitTypes, defaultCommitType, mentionAuthors, includePRLinks, includeCommitLinks } = inputs;
 
   const repoUrl = `https://github.com/${ owner }/${ repo }`;
   const commits: LogsI = {};
@@ -66,8 +66,8 @@ export async function generate(input: ChangelogInputI): Promise<string> {
 
       const reference: ReferenceI = {
         author: mentionAuthors ? commit.author?.login : null,
-        commit: commit.sha,
-        pr,
+        commit: includeCommitLinks ? commit.sha : null,
+        pr    : includePRLinks ? pr : null,
       };
 
       if (existingCommit == null) {
@@ -102,23 +102,29 @@ export async function generate(input: ChangelogInputI): Promise<string> {
       const baseLine = defaultCategory ? "" : "  ";
 
       for (const { title, references } of categoryGroup) {
-        changelog.push(`${ baseLine }* ${ title } (${ references
-          .map(reference => `${
-            reference.pr == null ? "" : `${ repoUrl }/pull/${ reference.pr } `
-          }${
-            repoUrl
-          }/commit/${
-            reference.commit
-          }${
-            reference.author == null
-              ? ""
-              : (
-                  reference.author.endsWith(APP_AUTHOR_SUFFIX)
-                    ? ` by [@${ reference.author }](https://github.com/apps/${ reference.author.slice(0, -APP_AUTHOR_SUFFIX_LENGTH) })`
-                    : ` by @${ reference.author }`
-                )
-          }`)
-          .join(", ") })`);
+        let log = `${ baseLine }* ${ title }`;
+
+        const links: string[] = [];
+
+        for (const { pr, commit, author } of references) {
+          const link: string[] = [];
+
+          if (pr != null) link.push(`${ repoUrl }/pull/${ pr }`);
+
+          if (commit != null) link.push(`${ repoUrl }/commit/${ commit }`);
+
+          if (author != null) {
+            // eslint-disable-next-line max-depth
+            if (author.endsWith(APP_AUTHOR_SUFFIX)) link.push(`by [@${ author }](https://github.com/apps/${ author.slice(0, -APP_AUTHOR_SUFFIX_LENGTH) })`);
+            else link.push(`by @${ author }`);
+          }
+
+          if (link.length > 0) links.push(link.join(" "));
+        }
+
+        if (links.length > 0) log += ` (${ links.join(", ") })`;
+
+        changelog.push(log);
       }
     }
 

action/index.js.map

@@ -19,8 +19,8 @@ export interface LogI {
 
 export interface ReferenceI {
   author?: string | null;
-  commit: string;
-  pr?: string;
+  commit: string | null;
+  pr?: string | null;
 }
 
 export interface TagInputI {
@@ -49,7 +49,9 @@ export interface ChangelogInputI {
 export interface ActionInputsI {
   commitTypes: TypesI;
   defaultCommitType: string;
+  includeCommitLinks: boolean;
   includeCompare: boolean;
+  includePRLinks: boolean;
   mentionAuthors: boolean;
   mentionNewContributors: boolean;
   releaseName: string;

src/changelog.ts

@@ -16,6 +16,8 @@ export async function getInputs(): Promise<ActionInputsI> {
     required: true,
   });
   const includeCompare = getBooleanInput("include-compare", { required: true });
+  const includePRLinks = getBooleanInput("include-pr-links", { required: true });
+  const includeCommitLinks = getBooleanInput("include-commit-links", { required: true });
   const semver = getBooleanInput("semver", { required: true });
 
   return Joi.object<ActionInputsI, true>()
@@ -28,6 +30,8 @@ export async function getInputs(): Promise<ActionInputsI> {
       mentionAuthors        : Joi.boolean().required(),
       mentionNewContributors: Joi.boolean().required(),
       includeCompare        : Joi.boolean().required(),
+      includePRLinks        : Joi.boolean().required(),
+      includeCommitLinks    : Joi.boolean().required(),
       semver                : Joi.boolean().required(),
     })
     .validateAsync({
@@ -37,6 +41,8 @@ export async function getInputs(): Promise<ActionInputsI> {
       mentionAuthors,
       mentionNewContributors,
       includeCompare,
+      includePRLinks,
+      includeCommitLinks,
       semver,
     });
 }