Hide details (#435)

* ✨ hide details

* 📦 build

* 👷 ci for hide_details option

.github/workflows/comment_on_workflow_run.yml

@@ -23,6 +23,17 @@ jobs:
           header: All
           number: ${{ steps.artifact.outputs.number }}
           message: |
+            <details open>
+            <summary>output of `yarn all`</summary>
+
             ```
             ${{ steps.artifact.outputs.all_result }}
             ```
+            </details>
+      - uses: ./
+        with:
+          header: All
+          append: true
+          hide_details: true
+          message: |
+            The build is over.

__tests__/comment.test.ts

@@ -5,6 +5,7 @@ import {
   createComment,
   deleteComment,
   findPreviousComment,
+  getBodyOf,
   updateComment
 } from "../src/comment"
 
@@ -177,3 +178,42 @@ it("deleteComment", async () => {
     repo: "sticky-pull-request-comment"
   })
 })
+
+describe("getBodyOf", () => {
+  const nullPrevious = {}
+  const simplePrevious = {
+    body: "hello there\n<!-- Sticky Pull Request CommentTypeA -->"
+  }
+  const detailsPrevious = {
+    body: `
+    <details open>
+    <summary>title</summary>
+
+    content
+    </details>
+    <!-- Sticky Pull Request CommentTypeA -->
+  `
+  }
+  const replaced = `
+    <details>
+    <summary>title</summary>
+
+    content
+    </details>
+    <!-- Sticky Pull Request CommentTypeA -->
+  `
+  test.each`
+    append   | hideDetails | previous           | expected
+    ${false} | ${false}    | ${detailsPrevious} | ${undefined}
+    ${true}  | ${false}    | ${nullPrevious}    | ${undefined}
+    ${true}  | ${false}    | ${detailsPrevious} | ${detailsPrevious.body}
+    ${true}  | ${true}     | ${nullPrevious}    | ${undefined}
+    ${true}  | ${true}     | ${simplePrevious}  | ${simplePrevious.body}
+    ${true}  | ${true}     | ${detailsPrevious} | ${replaced}
+  `(
+    "receive $previous, $append, $hideDetails and returns $expected",
+    ({append, hideDetails, previous, expected}) => {
+      expect(getBodyOf(previous, append, hideDetails)).toEqual(expected)
+    }
+  )
+})

__tests__/config.test.ts

@@ -4,6 +4,7 @@ beforeEach(() => {
   process.env["INPUT_APPEND"] = "false"
   process.env["INPUT_RECREATE"] = "false"
   process.env["INPUT_DELETE"] = "false"
+  process.env["INPUT_HIDE_DETAILS"] = "false"
   process.env["INPUT_GITHUB_TOKEN"] = "some-token"
 })
 
@@ -17,6 +18,7 @@ afterEach(() => {
   delete process.env["INPUT_APPEND"]
   delete process.env["INPUT_RECREATE"]
   delete process.env["INPUT_DELETE"]
+  delete process.env["INPUT_HIDE_DETAILS"]
   delete process.env["INPUT_GITHUB_TOKEN"]
   delete process.env["INPUT_PATH"]
 })
@@ -31,6 +33,7 @@ test("repo", () => {
     append: false,
     recreate: false,
     deleteOldComment: false,
+    hideDetails: false,
     githubToken: "some-token"
   })
 })
@@ -44,6 +47,7 @@ test("header", () => {
     append: false,
     recreate: false,
     deleteOldComment: false,
+    hideDetails: false,
     githubToken: "some-token"
   })
 })
@@ -57,6 +61,7 @@ test("append", () => {
     append: true,
     recreate: false,
     deleteOldComment: false,
+    hideDetails: false,
     githubToken: "some-token"
   })
 })
@@ -70,6 +75,7 @@ test("recreate", () => {
     append: false,
     recreate: true,
     deleteOldComment: false,
+    hideDetails: false,
     githubToken: "some-token"
   })
 })
@@ -83,6 +89,21 @@ test("delete", () => {
     append: false,
     recreate: false,
     deleteOldComment: true,
+    hideDetails: false,
+    githubToken: "some-token"
+  })
+})
+test("hideDetails", () => {
+  process.env["INPUT_HIDE_DETAILS"] = "true"
+  expect(require("../src/config")).toMatchObject({
+    pullRequestNumber: expect.any(Number),
+    repo: {owner: "marocchino", repo: "stick-pull-request-comment"},
+    body: "",
+    header: "",
+    append: false,
+    recreate: false,
+    deleteOldComment: false,
+    hideDetails: true,
     githubToken: "some-token"
   })
 })
@@ -97,6 +118,7 @@ describe("path", () => {
       append: false,
       recreate: false,
       deleteOldComment: false,
+      hideDetails: false,
       githubToken: "some-token"
     })
   })
@@ -111,6 +133,7 @@ describe("path", () => {
       append: false,
       recreate: false,
       deleteOldComment: false,
+      hideDetails: false,
       githubToken: "some-token"
     })
   })
@@ -126,6 +149,7 @@ test("message", () => {
     append: false,
     recreate: false,
     deleteOldComment: false,
+    hideDetails: false,
     githubToken: "some-token"
   })
 })

action.yml

@@ -18,6 +18,10 @@ inputs:
     description: "delete the previously created comment. Only `true` is allowed. Just skip this item when you don't need it."
     default: "false"
     required: false
+  hide_details:
+    description: "hide summary tags in the previously created comment. Only `true` is allowed. Just skip this item when you don't need it."
+    default: "false"
+    required: false
   message:
     description: "comment message"
     required: false

dist/index.js

@@ -35,7 +35,7 @@ var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, ge
     });
 };
 Object.defineProperty(exports, "__esModule", ({ value: true }));
-exports.deleteComment = exports.createComment = exports.updateComment = exports.findPreviousComment = void 0;
+exports.getBodyOf = exports.deleteComment = exports.createComment = exports.updateComment = exports.findPreviousComment = void 0;
 const core = __importStar(__nccwpck_require__(186));
 function headerComment(header) {
     return `<!-- Sticky Pull Request Comment${header} -->`;
@@ -75,6 +75,17 @@ function deleteComment(octokit, repo, comment_id) {
     });
 }
 exports.deleteComment = deleteComment;
+function getBodyOf(previous, append, hideDetails) {
+    var _a;
+    if (!append) {
+        return undefined;
+    }
+    if (!hideDetails) {
+        return previous.body;
+    }
+    return (_a = previous.body) === null || _a === void 0 ? void 0 : _a.replace(/(<details.*?)\s*\bopen\b(.*>)/g, "$1$2");
+}
+exports.getBodyOf = getBodyOf;
 
 
 /***/ }),
@@ -105,7 +116,7 @@ var __importStar = (this && this.__importStar) || function (mod) {
 };
 var _a, _b;
 Object.defineProperty(exports, "__esModule", ({ value: true }));
-exports.body = exports.githubToken = exports.deleteOldComment = exports.recreate = exports.append = exports.header = exports.repo = exports.pullRequestNumber = void 0;
+exports.body = exports.githubToken = exports.deleteOldComment = exports.recreate = exports.hideDetails = exports.append = exports.header = exports.repo = exports.pullRequestNumber = void 0;
 const core = __importStar(__nccwpck_require__(186));
 const github_1 = __nccwpck_require__(438);
 const fs_1 = __nccwpck_require__(747);
@@ -114,6 +125,9 @@ exports.pullRequestNumber = ((_b = (_a = github_1.context === null || github_1.c
 exports.repo = buildRepo();
 exports.header = core.getInput("header", { required: false });
 exports.append = core.getBooleanInput("append", { required: true });
+exports.hideDetails = core.getBooleanInput("hide_details", {
+    required: true
+});
 exports.recreate = core.getBooleanInput("recreate", { required: true });
 exports.deleteOldComment = core.getBooleanInput("delete", { required: true });
 exports.githubToken = core.getInput("GITHUB_TOKEN", { required: true });
@@ -206,7 +220,7 @@ function run() {
                 yield (0, comment_1.deleteComment)(octokit, config_1.repo, previous.id);
                 return;
             }
-            const previousBody = config_1.append ? previous.body : undefined;
+            const previousBody = (0, comment_1.getBodyOf)(previous, config_1.append, config_1.hideDetails);
             if (config_1.recreate) {
                 yield (0, comment_1.deleteComment)(octokit, config_1.repo, previous.id);
                 yield (0, comment_1.createComment)(octokit, config_1.repo, config_1.pullRequestNumber, config_1.body, config_1.header, previousBody);

lib/comment.js

@@ -28,7 +28,7 @@ var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, ge
     });
 };
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.deleteComment = exports.createComment = exports.updateComment = exports.findPreviousComment = void 0;
+exports.getBodyOf = exports.deleteComment = exports.createComment = exports.updateComment = exports.findPreviousComment = void 0;
 const core = __importStar(require("@actions/core"));
 function headerComment(header) {
     return `<!-- Sticky Pull Request Comment${header} -->`;
@@ -68,3 +68,14 @@ function deleteComment(octokit, repo, comment_id) {
     });
 }
 exports.deleteComment = deleteComment;
+function getBodyOf(previous, append, hideDetails) {
+    var _a;
+    if (!append) {
+        return undefined;
+    }
+    if (!hideDetails) {
+        return previous.body;
+    }
+    return (_a = previous.body) === null || _a === void 0 ? void 0 : _a.replace(/(<details.*?)\s*\bopen\b(.*>)/g, "$1$2");
+}
+exports.getBodyOf = getBodyOf;

lib/config.js

@@ -20,7 +20,7 @@ var __importStar = (this && this.__importStar) || function (mod) {
 };
 var _a, _b;
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.body = exports.githubToken = exports.deleteOldComment = exports.recreate = exports.append = exports.header = exports.repo = exports.pullRequestNumber = void 0;
+exports.body = exports.githubToken = exports.deleteOldComment = exports.recreate = exports.hideDetails = exports.append = exports.header = exports.repo = exports.pullRequestNumber = void 0;
 const core = __importStar(require("@actions/core"));
 const github_1 = require("@actions/github");
 const fs_1 = require("fs");
@@ -29,6 +29,9 @@ exports.pullRequestNumber = ((_b = (_a = github_1.context === null || github_1.c
 exports.repo = buildRepo();
 exports.header = core.getInput("header", { required: false });
 exports.append = core.getBooleanInput("append", { required: true });
+exports.hideDetails = core.getBooleanInput("hide_details", {
+    required: true
+});
 exports.recreate = core.getBooleanInput("recreate", { required: true });
 exports.deleteOldComment = core.getBooleanInput("delete", { required: true });
 exports.githubToken = core.getInput("GITHUB_TOKEN", { required: true });

lib/main.js

@@ -55,7 +55,7 @@ function run() {
                 yield (0, comment_1.deleteComment)(octokit, config_1.repo, previous.id);
                 return;
             }
-            const previousBody = config_1.append ? previous.body : undefined;
+            const previousBody = (0, comment_1.getBodyOf)(previous, config_1.append, config_1.hideDetails);
             if (config_1.recreate) {
                 yield (0, comment_1.deleteComment)(octokit, config_1.repo, previous.id);
                 yield (0, comment_1.createComment)(octokit, config_1.repo, config_1.pullRequestNumber, config_1.body, config_1.header, previousBody);

src/comment.ts

@@ -81,3 +81,19 @@ export async function deleteComment(
     comment_id
   })
 }
+
+export function getBodyOf(
+  previous: {body?: string},
+  append: boolean,
+  hideDetails: boolean
+): string | undefined {
+  if (!append) {
+    return undefined
+  }
+
+  if (!hideDetails) {
+    return previous.body
+  }
+
+  return previous.body?.replace(/(<details.*?)\s*\bopen\b(.*>)/g, "$1$2")
+}

src/config.ts

@@ -9,6 +9,9 @@ export const pullRequestNumber =
 export const repo = buildRepo()
 export const header = core.getInput("header", {required: false})
 export const append = core.getBooleanInput("append", {required: true})
+export const hideDetails = core.getBooleanInput("hide_details", {
+  required: true
+})
 export const recreate = core.getBooleanInput("recreate", {required: true})
 export const deleteOldComment = core.getBooleanInput("delete", {required: true})
 export const githubToken = core.getInput("GITHUB_TOKEN", {required: true})

src/main.ts

@@ -6,6 +6,7 @@ import {
   deleteOldComment,
   githubToken,
   header,
+  hideDetails,
   pullRequestNumber,
   recreate,
   repo
@@ -14,6 +15,7 @@ import {
   createComment,
   deleteComment,
   findPreviousComment,
+  getBodyOf,
   updateComment
 } from "./comment"
 
@@ -50,7 +52,7 @@ async function run(): Promise<undefined> {
       return
     }
 
-    const previousBody = append ? previous.body : undefined
+    const previousBody = getBodyOf(previous, append, hideDetails)
     if (recreate) {
       await deleteComment(octokit, repo, previous.id)
       await createComment(