don't update issue if content is identical

Author: maxim-lobanov

dist/index.js

@@ -166,25 +166,22 @@ exports.IssueContentParser = void 0;
 const utils_1 = __nccwpck_require__(918);
 class IssueContentParser {
     extractIssueTasklist(issue) {
-        var _a, _b;
-        const contentLines = (_b = (_a = issue.body) === null || _a === void 0 ? void 0 : _a.split("\n")) !== null && _b !== void 0 ? _b : [];
+        const contentLines = issue.body?.split("\n") ?? [];
         return contentLines
             .filter(x => this.isTaskListLine(x))
             .map(x => (0, utils_1.parseIssueUrl)(x))
             .filter((x) => x !== null);
     }
     extractIssueDependencies(issue) {
-        var _a, _b;
-        const contentLines = (_b = (_a = issue.body) === null || _a === void 0 ? void 0 : _a.split("\n")) !== null && _b !== void 0 ? _b : [];
+        const contentLines = issue.body?.split("\n") ?? [];
         return contentLines
             .filter(x => this.isDependencyLine(x))
             .map(x => (0, utils_1.parseIssuesUrls)(x))
             .flat()
             .filter((x) => x !== null);
     }
     replaceIssueContent(issue, sectionTitle, newSectionContent) {
-        var _a, _b;
-        const contentLines = (_b = (_a = issue.body) === null || _a === void 0 ? void 0 : _a.split("\n")) !== null && _b !== void 0 ? _b : [];
+        const contentLines = issue.body?.split("\n") ?? [];
         const sectionStartIndex = contentLines.findIndex(x => this.isMarkdownHeaderLine(x, sectionTitle));
         if (sectionStartIndex === -1) {
             throw new Error(`Markdown header '${sectionTitle}' is not found in issue body.`);
@@ -197,6 +194,16 @@ class IssueContentParser {
             ...contentLines.slice(sectionEndIndex !== -1 ? sectionEndIndex : contentLines.length),
         ].join("\n");
     }
+    isIssueContentIdentical(issue, newIssueContent) {
+        // GitHub automatically replace "\n" to "\r\n" line endings when issue body is modified through GitHub UI.
+        // Replace "\r\n" to "\n" before comparing content to avoid unnecessary issue updates.
+        const rawIssueBody = issue.body ?? "";
+        const formattedIssueBody = rawIssueBody.replaceAll("\r\n", "\n");
+        const formattedNewIssueContent = newIssueContent.replaceAll("\r\n", "\n");
+        console.log(JSON.stringify(formattedIssueBody));
+        console.log(JSON.stringify(formattedNewIssueContent));
+        return formattedIssueBody === formattedNewIssueContent;
+    }
     isMarkdownHeaderLine(str, sectionTitle) {
         if (!str.startsWith("#")) {
             return false;
@@ -290,6 +297,10 @@ const run = async () => {
         core.startGroup("Updated root issue content");
         core.info(updatedIssueContent);
         core.endGroup();
+        if (issueContentParser.isIssueContentIdentical(rootIssue, updatedIssueContent)) {
+            core.info("Skipping update of root issue content because new content is identical to current content. No changes in mermaid in diagram.");
+            return;
+        }
         if (inputs.dryRun) {
             console.log("Action is run in dry-run mode. Root issue won't be updated");
             return;

src/issue-content-parser.ts

@@ -41,6 +41,19 @@ export class IssueContentParser {
         ].join("\n");
     }
 
+    public isIssueContentIdentical(issue: GitHubIssue, newIssueContent: string) {
+        // GitHub automatically replace "\n" to "\r\n" line endings when issue body is modified through GitHub UI.
+        // Replace "\r\n" to "\n" before comparing content to avoid unnecessary issue updates.
+        const rawIssueBody = issue.body ?? "";
+        const formattedIssueBody = rawIssueBody.replaceAll("\r\n", "\n");
+        const formattedNewIssueContent = newIssueContent.replaceAll("\r\n", "\n");
+
+        console.log(JSON.stringify(formattedIssueBody));
+        console.log(JSON.stringify(formattedNewIssueContent));
+
+        return formattedIssueBody === formattedNewIssueContent;
+    }
+
     public isMarkdownHeaderLine(str: string, sectionTitle?: string): boolean {
         if (!str.startsWith("#")) {
             return false;

src/main.ts

@@ -48,6 +48,13 @@ const run = async (): Promise<void> => {
         core.info(updatedIssueContent);
         core.endGroup();
 
+        if (issueContentParser.isIssueContentIdentical(rootIssue, updatedIssueContent)) {
+            core.info(
+                "Skipping update of root issue content because new content is identical to current content. No changes in mermaid in diagram."
+            );
+            return;
+        }
+
         if (inputs.dryRun) {
             console.log("Action is run in dry-run mode. Root issue won't be updated");
             return;

tests/issue-content-parser.test.ts

@@ -366,6 +366,35 @@ new diagram content
         });
     });
 
+    describe("isIssueContentIdentical", () => {
+        it("content is identical", () => {
+            const issue = {
+                body: "# Header\r\nHello world\r\n\r\n## Header 2\r\n\r\n```mermaid\ntest content\n```\n\r\n## Header 3\r\nFooter",
+            } as GitHubIssue;
+            const newIssueContent =
+                "# Header\r\nHello world\r\n\r\n## Header 2\r\n\r\n```mermaid\ntest content\n```\n\r\n## Header 3\r\nFooter";
+            expect(issueContentParser.isIssueContentIdentical(issue, newIssueContent)).toBeTruthy();
+        });
+
+        it("content is identical but different line endings", () => {
+            const issue = {
+                body: "# Header\r\nHello world\r\n\r\n## Header 2\r\n\r\n```mermaid\r\ntest content\r\n```\r\n\r\n## Header 3\r\nFooter",
+            } as GitHubIssue;
+            const newIssueContent =
+                "# Header\r\nHello world\r\n\r\n## Header 2\r\n\r\n```mermaid\ntest content\n```\n\r\n## Header 3\r\nFooter";
+            expect(issueContentParser.isIssueContentIdentical(issue, newIssueContent)).toBeTruthy();
+        });
+
+        it("content is different", () => {
+            const issue = {
+                body: "# Header\r\nHello world\r\n\r\n## Header 2\r\n\r\n```mermaid\r\ntest content\r\n```\r\n\r\n## Header 3\r\nFooter",
+            } as GitHubIssue;
+            const newIssueContent =
+                "# Header\r\nHello world\r\n\r\n## Header 2\r\n\r\n```mermaid\ntest content 2\n```\n\r\n## Header 3\r\nFooter";
+            expect(issueContentParser.isIssueContentIdentical(issue, newIssueContent)).toBeFalsy();
+        });
+    });
+
     describe("isMarkdownHeaderLine", () => {
         it("non-header line", () => {
             expect(issueContentParser.isMarkdownHeaderLine("Epic 1")).toBeFalsy();

tsconfig.json

@@ -1,6 +1,6 @@
 {
     "compilerOptions": {
-      "target": "ES2019",
+      "target": "ES2021",
       "module": "commonjs",
       "outDir": "./lib",
       "rootDir": "./src",