actions/marocchino-sticky-pull-request-comment
2
0
Fork 0
mirror of https://github.com/marocchino/sticky-pull-request-comment.git synced 2025-12-15 20:56:31 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions

update hidden identifier comment to come last instead of first

Browse source
This commit is contained in:
Jake Hiller 2020-06-24 10:38:30 -04:00
parent 587f474c3a
commit 1ee5fc7fa0
2 changed files with 27 additions and 14 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

29
__tests__/comment.test.ts
View file

@ -9,14 +9,20 @@ it("findPreviousComment", async () => {
user: { user: {
login: "github-actions[bot]" login: "github-actions[bot]"
}, },
body: "<!-- Sticky Pull Request Comment -->\nprevious message" body: "previous message\n<!-- Sticky Pull Request Comment -->"
}; };
const commentWithCustomHeader = { const commentWithCustomHeader = {
user: { user: {
login: "github-actions[bot]" login: "github-actions[bot]"
}, },
body: "<!-- Sticky Pull Request CommentTypeA -->\nprevious message" body: "previous message\n<!-- Sticky Pull Request CommentTypeA -->"
}; };
const headerFirstComment = {
user: {
login: "github-actions[bot]"
},
body: "<!-- Sticky Pull Request CommentLegacyComment -->\nheader first message"
}
const otherComments = [ const otherComments = [
{ {
user: { user: {
@ -28,14 +34,14 @@ it("findPreviousComment", async () => {
user: { user: {
login: "github-actions[bot]" login: "github-actions[bot]"
}, },
body: "<!-- Sticky Pull Request CommentTypeB -->\nprevious message" body: "previous message\n<!-- Sticky Pull Request CommentTypeB -->"
} },
]; ];
const octokit = { const octokit = {
issues: { issues: {
listComments: jest.fn(() => listComments: jest.fn(() =>
Promise.resolve({ Promise.resolve({
data: [commentWithCustomHeader, comment, ...otherComments] data: [commentWithCustomHeader, comment, headerFirstComment, ...otherComments]
}) })
) )
} }
@ -45,6 +51,7 @@ it("findPreviousComment", async () => {
expect(await findPreviousComment(octokit, repo, 123, "TypeA")).toBe( expect(await findPreviousComment(octokit, repo, 123, "TypeA")).toBe(
commentWithCustomHeader commentWithCustomHeader
); );
expect(await findPreviousComment(octokit, repo, 123, "LegacyComment")).toBe(headerFirstComment)
expect(octokit.issues.listComments).toBeCalledWith({ issue_number: 123 }); expect(octokit.issues.listComments).toBeCalledWith({ issue_number: 123 });
}); });
it("updateComment", async () => { it("updateComment", async () => {
@ -58,22 +65,22 @@ it("updateComment", async () => {
).toBeUndefined(); ).toBeUndefined();
expect(octokit.issues.updateComment).toBeCalledWith({ expect(octokit.issues.updateComment).toBeCalledWith({
comment_id: 456, comment_id: 456,
body: "<!-- Sticky Pull Request Comment -->\nhello there" body: "hello there\n<!-- Sticky Pull Request Comment -->"
}); });
expect( expect(
await updateComment(octokit, repo, 456, "hello there", "TypeA") await updateComment(octokit, repo, 456, "hello there", "TypeA")
).toBeUndefined(); ).toBeUndefined();
expect(octokit.issues.updateComment).toBeCalledWith({ expect(octokit.issues.updateComment).toBeCalledWith({
comment_id: 456, comment_id: 456,
body: "<!-- Sticky Pull Request CommentTypeA -->\nhello there" body: "hello there\n<!-- Sticky Pull Request CommentTypeA -->"
}); });
expect( expect(
await updateComment(octokit, repo, 456, "hello there", "TypeA", "<!-- Sticky Pull Request CommentTypeA -->\nhello there") await updateComment(octokit, repo, 456, "hello there", "TypeA", "hello there\n<!-- Sticky Pull Request CommentTypeA -->")
).toBeUndefined(); ).toBeUndefined();
expect(octokit.issues.updateComment).toBeCalledWith({ expect(octokit.issues.updateComment).toBeCalledWith({
comment_id: 456, comment_id: 456,
body: "<!-- Sticky Pull Request CommentTypeA -->\nhello there\nhello there" body: "hello there\nhello there\n<!-- Sticky Pull Request CommentTypeA -->"
}); });
}); });
it("createComment", async () => { it("createComment", async () => {
@ -87,13 +94,13 @@ it("createComment", async () => {
).toBeUndefined(); ).toBeUndefined();
expect(octokit.issues.createComment).toBeCalledWith({ expect(octokit.issues.createComment).toBeCalledWith({
issue_number: 456, issue_number: 456,
body: "<!-- Sticky Pull Request Comment -->\nhello there" body: "hello there\n<!-- Sticky Pull Request Comment -->"
}); });
expect( expect(
await createComment(octokit, repo, 456, "hello there", "TypeA") await createComment(octokit, repo, 456, "hello there", "TypeA")
).toBeUndefined(); ).toBeUndefined();
expect(octokit.issues.createComment).toBeCalledWith({ expect(octokit.issues.createComment).toBeCalledWith({
issue_number: 456, issue_number: 456,
body: "<!-- Sticky Pull Request CommentTypeA -->\nhello there" body: "hello there\n<!-- Sticky Pull Request CommentTypeA -->"
}); });
}); });

12
src/comment.ts
View file

@ -2,25 +2,31 @@ function headerComment(header) {
return `<!-- Sticky Pull Request Comment${header} -->`; return `<!-- Sticky Pull Request Comment${header} -->`;
} }
function removeHeaderComment(body, header) {
return body.replace(`\n${header}`, '');
}
export async function findPreviousComment(octokit, repo, issue_number, header) { export async function findPreviousComment(octokit, repo, issue_number, header) {
const { data: comments } = await octokit.issues.listComments({ const { data: comments } = await octokit.issues.listComments({
...repo, ...repo,
issue_number issue_number
}); });
const h = headerComment(header); const h = headerComment(header);
return comments.find(comment => comment.body.startsWith(h)); return comments.find(comment => comment.body.includes(h));
} }
export async function updateComment(octokit, repo, comment_id, body, header, previousBody?) { export async function updateComment(octokit, repo, comment_id, body, header, previousBody?) {
const headerIdentifier = headerComment(header);
const updatedBody = previousBody ? `${removeHeaderComment(previousBody, headerIdentifier)}\n${body}` : body;
await octokit.issues.updateComment({ await octokit.issues.updateComment({
...repo, ...repo,
comment_id, comment_id,
body: previousBody ? `${previousBody}\n${body}` : `${headerComment(header)}\n${body}` body: `${updatedBody}\n${headerIdentifier}`
}); });
} }
export async function createComment(octokit, repo, issue_number, body, header) { export async function createComment(octokit, repo, issue_number, body, header) {
await octokit.issues.createComment({ await octokit.issues.createComment({
...repo, ...repo,
issue_number, issue_number,
body: `${headerComment(header)}\n${body}` body: `${body}\n${headerComment(header)}`
}); });
} }