Merge pull request #54 from millerick/mmillerick/replace-in-place

Replace Jira information in the location it originally appeared in the pull request description

README.md

@@ -31,7 +31,12 @@ jobs:
 ```
 `
 ## Features
-When a PR passes the above check, `jira-description-action` will also add the issue details to the top of the PR description. 
+When a PR passes the above check, `jira-description-action` will also add the issue details to the top of the PR description. The issue details can be placed in a specific section of the PR description by including the following markers in the [pull request template](https://docs.github.com/en/communities/using-templates-to-encourage-useful-issues-and-pull-requests/creating-a-pull-request-template-for-your-repository#adding-a-pull-request-template) for the repository.
+```
+<!--jira-description-action-hidden-marker-start-->
+
+<!--jira-description-action-hidden-marker-end-->
+```
 
 ### Options
 

__tests__/utils.test.ts

@@ -98,5 +98,17 @@ ${HIDDEN_MARKER_START}
 ${issueInfo}
 ${HIDDEN_MARKER_END}
 ${oldPRBodyInformation}`);
-  })
+  });
+
+  it('respects the location of HIDDEN_MARKER_START and HIDDEN_MARKER_END when they already exist in the pull request body', () => {
+    const issueInfo = 'new info about jira task';
+    const oldPRDescription = `this is text above the markers
+${WARNING_MESSAGE_ABOUT_HIDDEN_MARKERS}
+${HIDDEN_MARKER_START}
+${issueInfo}
+${HIDDEN_MARKER_END}
+this is text below the markers`;
+    const description = getPRDescription(oldPRDescription, issueInfo);
+    expect(description).toEqual(oldPRDescription);
+  });
 });

src/utils.ts

@@ -60,13 +60,15 @@ export const getPRDescription = (oldBody: string, details: string): string => {
 
   const replaceDetailsRg = new RegExp(`${hiddenMarkerStartRg}([\\s\\S]+)${hiddenMarkerEndRg}[\\s]?`, 'igm');
   const replaceWarningMessageRg = new RegExp(`${warningMsgRg}[\\s]?`, 'igm');
-  const bodyWithoutJiraDetails = (oldBody ?? '').replace(replaceDetailsRg, '').replace(replaceWarningMessageRg, '');
-
-  return `${WARNING_MESSAGE_ABOUT_HIDDEN_MARKERS}
+  const jiraDetailsMessage = `${WARNING_MESSAGE_ABOUT_HIDDEN_MARKERS}
 ${HIDDEN_MARKER_START}
 ${details}
 ${HIDDEN_MARKER_END}
-${bodyWithoutJiraDetails}`;
+`;
+  if (replaceDetailsRg.test(oldBody)) {
+    return (oldBody ?? '').replace(replaceWarningMessageRg, '').replace(replaceDetailsRg, jiraDetailsMessage);
+  }
+  return jiraDetailsMessage + oldBody;
 };
 
 export const buildPRDescription = (details: JIRADetails) => {