Merge pull request #5 from btwrk/feature/null-pr-body

Pass body to pr update
jira-tools · Jul 29, 2022 · bd5a5cb · bd5a5cb
2 parents 6ae34de + 633eff0
commit bd5a5cb
Show file tree

Hide file tree

Showing 7 changed files with 29 additions and 19 deletions.
diff --git a/__tests__/github.test.ts b/__tests__/github.test.ts
@@ -102,6 +102,7 @@ some actual content'
   });
 
   it('should return true when the hidden marker is NOT present', () => {
+    expect(GitHub.shouldUpdatePRDescription(null)).toBeTruthy();
     expect(GitHub.shouldUpdatePRDescription('')).toBeTruthy();
     expect(GitHub.shouldUpdatePRDescription('added_by')).toBeTruthy();
     expect(GitHub.shouldUpdatePRDescription('added_by_something_else')).toBeTruthy();

diff --git a/__tests__/jira.test.ts b/__tests__/jira.test.ts
@@ -52,17 +52,18 @@ describe('getJIRAIssueKeys()', () => {
 });
 
 describe('getPRDescription()', () => {
+  const issue: JIRADetails = {
+    key: 'ABC-123',
+    url: 'url',
+    type: { name: 'feature', icon: 'feature-icon-url' },
+    estimate: 1,
+    labels: [{ name: 'frontend', url: 'frontend-url' }],
+    summary: 'Story title or summary',
+    project: { name: 'project', url: 'project-url', key: 'abc' },
+    status: 'In Progress',
+  };
+
   it('should include the hidden marker when getting PR description', () => {
-    const issue: JIRADetails = {
-      key: 'ABC-123',
-      url: 'url',
-      type: { name: 'feature', icon: 'feature-icon-url' },
-      estimate: 1,
-      labels: [{ name: 'frontend', url: 'frontend-url' }],
-      summary: 'Story title or summary',
-      project: { name: 'project', url: 'project-url', key: 'abc' },
-      status: 'In Progress',
-    };
     const description = Jira.getPRDescription('some_body', issue);
 
     expect(GitHub.shouldUpdatePRDescription(description)).toBeFalsy();
@@ -71,6 +72,15 @@ describe('getPRDescription()', () => {
     expect(description).toContain(issue.status);
     expect(description).toContain(issue.labels[0].name);
   });
+
+  it('should work with null description', () => {
+    const description = Jira.getPRDescription(null, issue);
+
+    expect(description).toContain(issue.key);
+    expect(description).toContain(issue.estimate.toString());
+    expect(description).toContain(issue.status);
+    expect(description).toContain(issue.labels[0].name);
+  });
 });
 
 describe('getNoIdComment()', () => {

diff --git a/lib/index.js b/lib/index.js
diff --git a/lib/index.js.map b/lib/index.js.map
diff --git a/src/github.ts b/src/github.ts
@@ -38,10 +38,9 @@ export class GitHub {
   /** Update a PR details. */
   updatePrDetails = async (prData: PullRequestUpdateParams): Promise<void> => {
     try {
+      const { owner, repo, pullRequestNumber, body } = prData;
       // eslint-disable-next-line @typescript-eslint/naming-convention
-      const { owner, repo, pullRequestNumber: pull_number } = prData;
-      // eslint-disable-next-line @typescript-eslint/naming-convention
-      await this.client.pulls.update({ owner, repo, pull_number });
+      await this.client.pulls.update({ owner, repo, pull_number: pullRequestNumber, body });
     } catch (error) {
       console.error(error);
       // eslint-disable-next-line i18n-text/no-en
@@ -166,7 +165,7 @@ export class GitHub {
    */
   static shouldUpdatePRDescription = (
     /** The PR description/body as a string. */
-    body?: string
+    body: string | null
   ): boolean => {
     if (typeof body === 'string' && body != null && body !== undefined) {
       // Check if the body contains the hidden marker and return false

diff --git a/src/jira.ts b/src/jira.ts
@@ -96,7 +96,7 @@ export class Jira {
   };
 
   /** Get PR description with story/issue details. */
-  static getPRDescription = (body: string, details: JIRADetails): string => {
+  static getPRDescription = (body: string | null, details: JIRADetails): string => {
     const displayKey = details.key.toUpperCase();
 
     let description = `

diff --git a/src/main.ts b/src/main.ts
@@ -152,13 +152,13 @@ async function run(): Promise<void> {
       if (GitHub.shouldUpdatePRDescription(prBody)) {
         console.log('Updating PR description…', prBody);
 
-        const body: string = Jira.getPRDescription(prBody, details);
+        const description: string = Jira.getPRDescription(prBody, details);
 
         const prData: PullRequestUpdateParams = {
           owner,
           repo,
           pullRequestNumber: prNumber,
-          body,
+          body: description,
         };
         await gh.updatePrDetails(prData);