Add support for skip gif flag

README.md

@@ -134,6 +134,7 @@ When a PR passes the above check, `jira-lint` will also add the issue details to
 | `jira-base-url` | The subdomain of JIRA cloud that you use to access it. Ex: "https://your-domain.atlassian.net".                                                                                                                                                                                                                    | true     | null    |
 | `skip-branches` | A regex to ignore running `jira-lint` on certain branches, like production etc.                                                                                                                                                                                                                                    | false    | ' '     |
 | `skip-comments` | A `Boolean` if set to `true` then `jira-lint` will skip adding lint comments for PR title.                                                                                                                                                                                                                         | false    | false   |
+| `skip-gifs`     | A `Boolean` if set to `true` then `jira-lint` will skip adding any gifs.                                                                                                                                                                                                                                           | false    | false   |
 | `pr-threshold`  | An `Integer` based on which `jira-lint` will add a comment discouraging huge PRs.                                                                                                                                                                                                                                  | false    | 800     |
 
 Since tokens are private, we suggest adding them as [GitHub secrets](https://help.github.com/en/actions/automating-your-workflow-with-github-actions/creating-and-using-encrypted-secrets).

__tests__/utils.test.ts

@@ -11,6 +11,7 @@ import {
   shouldSkipBranchLint,
   shouldUpdatePRDescription,
   getJIRAClient,
+  getPRTitleComment,
 } from '../src/utils';
 import { HIDDEN_MARKER } from '../src/constants';
 import { JIRADetails } from '../src/types';
@@ -205,11 +206,23 @@ describe('getNoIdComment()', () => {
 
 describe('getHugePrComment()', () => {
   it('should return the comment content with additions and threshold', () => {
-    expect(getHugePrComment(1000, 800)).toContain(1000);
-    expect(getHugePrComment(1000, 800)).toContain(800);
+    expect(getHugePrComment(1000, 800, 'true')).toContain(1000);
+    expect(getHugePrComment(1000, 800, 'true')).toContain(800);
+  });
+  it('should return no gifs if they are skipped', () => {
+    expect(getHugePrComment(1000, 800, 'true')).not.toContain('giphy.com');
+    expect(getHugePrComment(1000, 800, 'false')).toContain('giphy.com');
   });
 });
 
+describe('getPRTitleComment()', () => {
+  it('should return no gifs if they are skipped', () => {
+    expect(getPRTitleComment('title', 'title', 'true')).not.toContain('giphy.com');
+    expect(getPRTitleComment('title', 'title', 'false')).toContain('giphy.com');
+  });
+});
+
+
 describe('getLabelsForDisplay()', () => {
   it('generates label markup without spaces', () => {
     expect(getLabelsForDisplay([

action.yml

@@ -19,6 +19,10 @@ inputs:
     description: 'A boolean if set to true, will skip adding lint comments for PR title.'
     required: false
     default: false
+  skip-gifs:
+    description: 'A boolean if set to true, will skip adding gifs to comments.'
+    required: false
+    default: false
   pr-threshold:
     description: 'An `Integer` based on which jira-lint add a comment discouraging huge PRs. Is disabled by `skip-comments`'
     required: false

src/main.ts

@@ -27,21 +27,23 @@ const getInputs = () => {
   const GITHUB_TOKEN: string = core.getInput('github-token', { required: true });
   const BRANCH_IGNORE_PATTERN: string = core.getInput('skip-branches', { required: false }) || '';
   const SKIP_COMMENTS: string = core.getInput('skip-comments', { required: false }) || 'false';
+  const SKIP_GIFS: string = core.getInput('skip-gifs', { required: false }) || 'false';
   const PR_THRESHOLD: string = core.getInput('pr-threshold', { required: false }) || '';
 
   return {
     JIRA_TOKEN,
     GITHUB_TOKEN,
     BRANCH_IGNORE_PATTERN,
     SKIP_COMMENTS,
+    SKIP_GIFS,
     PR_THRESHOLD,
     JIRA_BASE_URL: JIRA_BASE_URL.endsWith('/') ? JIRA_BASE_URL.replace(/\/$/, '') : JIRA_BASE_URL,
   };
 };
 
 async function run() {
   try {
-    const { JIRA_TOKEN, JIRA_BASE_URL, GITHUB_TOKEN, BRANCH_IGNORE_PATTERN, SKIP_COMMENTS, PR_THRESHOLD } = getInputs();
+    const { JIRA_TOKEN, JIRA_BASE_URL, GITHUB_TOKEN, BRANCH_IGNORE_PATTERN, SKIP_COMMENTS, SKIP_GIFS, PR_THRESHOLD } = getInputs();
 
     const defaultAdditionsCount = 800;
     const prThreshold: number = PR_THRESHOLD ? Number(PR_THRESHOLD) : defaultAdditionsCount;
@@ -137,7 +139,7 @@ async function run() {
         if (shouldAddComments(SKIP_COMMENTS)) {
           const prTitleComment: IssuesCreateCommentParams = {
             ...commonPayload,
-            body: getPRTitleComment(details.summary, title),
+            body: getPRTitleComment(details.summary, title, SKIP_GIFS),
           };
           console.log('Adding comment for the PR title');
           addComment(client, prTitleComment);
@@ -146,7 +148,7 @@ async function run() {
           if (isHumongousPR(additions, prThreshold)) {
             const hugePrComment: IssuesCreateCommentParams = {
               ...commonPayload,
-              body: getHugePrComment(additions, prThreshold),
+              body: getHugePrComment(additions, prThreshold, SKIP_GIFS),
             };
             console.log('Adding comment for huge PR');
             addComment(client, hugePrComment);

src/utils.ts

@@ -160,7 +160,7 @@ export const addComment = async (client: github.GitHub, comment: IssuesCreateCom
 /**
  *  Get a comment based on story title and PR title similarity
  */
-export const getPRTitleComment = (storyTitle: string, prTitle: string): string => {
+export const getPRTitleComment = (storyTitle: string, prTitle: string, skipGifs: string): string => {
   const matchRange: number = similarity.compareTwoStrings(storyTitle, prTitle);
   if (matchRange < 0.2) {
     return `<p>
@@ -209,9 +209,14 @@ export const getPRTitleComment = (storyTitle: string, prTitle: string): string =
     </p>
     `;
   }
-  return `<p>I'm a bot and I 👍 this PR title. 🤖</p>
 
-  <img src="https://media.giphy.com/media/XreQmk7ETCak0/giphy.gif" width="400" />`;
+  let s = `<p>I'm a bot and I 👍 this PR title. 🤖</p>`;
+  if (skipGifs !== 'true') {
+    s += `
+
+    <img src="https://media.giphy.com/media/XreQmk7ETCak0/giphy.gif" width="400" />`;
+  }
+  return s
 };
 
 /**
@@ -322,9 +327,13 @@ export const isHumongousPR = (additions: number, threshold: number): boolean =>
  * @param {number} addtions
  * @return {string}
  */
-export const getHugePrComment = (additions: number, threshold: number): string =>
-  `<p>This PR is too huge for one to review :broken_heart: </p>
-  <img src="https://media.giphy.com/media/26tPskka6guetcHle/giphy.gif" width="400" />
+export const getHugePrComment = (additions: number, threshold: number, skipGifs: string): string => {
+  let s = `<p>This PR is too huge for one to review :broken_heart: </p>`
+  if (skipGifs !== 'true') {
+    s += `
+    <img src="https://media.giphy.com/media/26tPskka6guetcHle/giphy.gif" width="400" />`
+  }
+  s += `
     <table>
       <tr>
           <th>Additions</th>
@@ -342,6 +351,8 @@ export const getHugePrComment = (additions: number, threshold: number): string =
       Check out this <a href="https://www.atlassian.com/blog/git/written-unwritten-guide-pull-requests">guide</a> to learn more about PR best-practices.
     </p>
   `;
+  return s
+};
 
 /**
  * Get the comment body for pr with no JIRA id in the branch name