Adds PR Body to Content Checked, and an Issue Key Prefix

.tool-versions

@@ -0,0 +1 @@
+nodejs 14.14.0

__tests__/utils.test.ts

@@ -212,8 +212,12 @@ describe('isHumongousPR()', () => {
 });
 
 describe('getNoIdComment()', () => {
-  it('should return the comment content with the branch name', () => {
-    expect(getNoIdComment('test_new_feature')).toContain('test_new_feature');
+  it('should return the comment content with the branch name, title and body', () => {
+    expect(getNoIdComment('test_new_feature', 'new feature', 'this is a new feature')).toContain('test_new_feature');
+    expect(getNoIdComment('test_new_feature', 'new feature', 'this is a new feature')).toContain('new feature');
+    expect(getNoIdComment('test_new_feature', 'new feature', 'this is a new feature')).toContain(
+      'this is a new feature'
+    );
   });
 });
 

src/constants.ts

@@ -15,11 +15,6 @@ export const BOT_BRANCH_PATTERNS: RegExp[] = [/^dependabot/, /^all-contributors/
  */
 export const DEFAULT_BRANCH_PATTERNS: RegExp[] = [/^master$/, /^production$/, /^gh-pages$/];
 
-/**
- * Regex to match JIRA issue keys.
- */
-export const JIRA_REGEX_MATCHER = /\d+-(([A-Z0-9]{1,10})|[a-z0-9]{1,10})/g;
-
 /**
  * Default total maximum number of additions after which jira-lint will discourage the PR as it is
  * considered "too huge to review".

src/main.ts

@@ -32,6 +32,7 @@ const getInputs = (): JIRALintActionInputs => {
   const PR_THRESHOLD = parseInt(core.getInput('pr-threshold', { required: false }), 10);
   const VALIDATE_ISSUE_STATUS: boolean = core.getInput('validate_issue_status', { required: false }) === 'true';
   const ALLOWED_ISSUE_STATUSES: string = core.getInput('allowed_issue_statuses');
+  const ISSUE_KEY_PREFIX: string = core.getInput('issue-key-prefix', { required: true });
 
   return {
     JIRA_TOKEN,
@@ -42,6 +43,7 @@ const getInputs = (): JIRALintActionInputs => {
     JIRA_BASE_URL: JIRA_BASE_URL.endsWith('/') ? JIRA_BASE_URL.replace(/\/$/, '') : JIRA_BASE_URL,
     VALIDATE_ISSUE_STATUS,
     ALLOWED_ISSUE_STATUSES,
+    ISSUE_KEY_PREFIX,
   };
 };
 
@@ -56,6 +58,7 @@ async function run(): Promise<void> {
       PR_THRESHOLD,
       VALIDATE_ISSUE_STATUS,
       ALLOWED_ISSUE_STATUSES,
+      ISSUE_KEY_PREFIX,
     } = getInputs();
 
     const defaultAdditionsCount = 800;
@@ -114,11 +117,11 @@ async function run(): Promise<void> {
       process.exit(0);
     }
 
-    const issueKeys = getJIRAIssueKeys(headBranch);
+    const issueKeys = getJIRAIssueKeys(`${headBranch} ${title} ${prBody}`, ISSUE_KEY_PREFIX);
     if (!issueKeys.length) {
       const comment: IssuesCreateCommentParams = {
         ...commonPayload,
-        body: getNoIdComment(headBranch),
+        body: getNoIdComment(headBranch, title, prBody),
       };
       await addComment(client, comment);
 
@@ -189,7 +192,7 @@ async function run(): Promise<void> {
     } else {
       const comment: IssuesCreateCommentParams = {
         ...commonPayload,
-        body: getNoIdComment(headBranch),
+        body: getNoIdComment(headBranch, title, prBody),
       };
       await addComment(client, comment);
 

src/types.ts

@@ -121,6 +121,7 @@ export interface JIRALintActionInputs {
   PR_THRESHOLD: number;
   VALIDATE_ISSUE_STATUS: boolean;
   ALLOWED_ISSUE_STATUSES: string;
+  ISSUE_KEY_PREFIX: string;
 }
 
 export interface JIRAClient {

src/utils.ts

@@ -3,13 +3,7 @@ import * as core from '@actions/core';
 import * as github from '@actions/github';
 import similarity from 'string-similarity';
 import { IssuesAddLabelsParams, PullsUpdateParams, IssuesCreateCommentParams } from '@octokit/rest';
-import {
-  MARKER_REGEX,
-  BOT_BRANCH_PATTERNS,
-  DEFAULT_BRANCH_PATTERNS,
-  JIRA_REGEX_MATCHER,
-  HIDDEN_MARKER,
-} from './constants';
+import { MARKER_REGEX, BOT_BRANCH_PATTERNS, DEFAULT_BRANCH_PATTERNS, HIDDEN_MARKER } from './constants';
 import { JIRA, JIRADetails, JIRAClient } from './types';
 
 export const isBlank = (input: string): boolean => input.trim().length === 0;
@@ -19,7 +13,8 @@ export const isNotBlank = (input: string): boolean => !isBlank(input);
 export const reverseString = (input: string): string => input.split('').reverse().join('');
 
 /** Extract JIRA issue keys from a string. */
-export const getJIRAIssueKeys = (input: string): string[] => {
+export const getJIRAIssueKeys = (input: string, issueKeyPrefix: string): string[] => {
+  const JIRA_REGEX_MATCHER = new RegExp(`\\d+-${reverseString(issueKeyPrefix)}`, 'gi');
   const matches = reverseString(input).toUpperCase().match(JIRA_REGEX_MATCHER);
   if (matches?.length) {
     return matches.map(reverseString).reverse();
@@ -319,9 +314,11 @@ export const getHugePrComment = (
   `;
 
 /** Get the comment body for pr with no JIRA id in the branch name. */
-export const getNoIdComment = (branch: string): string => {
-  return `<p> A JIRA Issue ID is missing from your branch name! 🦄</p>
+export const getNoIdComment = (branch: string, title: string, prBody: string): string => {
+  return `<p> A JIRA Issue ID is missing from your branch name, PR title and PR description! 🦄</p>
 <p>Your branch: ${branch}</p>
+<p>Your PR title: ${title}</p>
+<p>Your PR description: ${prBody}</p>
 <p>If this is your first time contributing to this repository - welcome!</p>
 <hr />
 <p>Please refer to <a href="https://github.com/cleartax/jira-lint">jira-lint</a> to get started.