Skip to content

feat: support updating an existing comment instead of creating one #303

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 2 commits into
base: master
Choose a base branch
from
Open

feat: support updating an existing comment instead of creating one #303

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
c62d587
feat: support updating an existing comment instead of creating one
Merott Jan 17, 2023
0cfb0a1
add the time of the deployment to the PR comment
Merott Jan 17, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
3 changes: 2 additions & 1 deletion README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -83,7 +83,8 @@ Here are all the inputs [deploy-to-vercel-action](https://github.com/BetaHuhn/de
| `GITHUB_DEPLOYMENT` | Create a deployment on GitHub | **No** | true |
| `GITHUB_DEPLOYMENT_ENV` | Custom environment for the GitHub deployment. | **No** | `Production` or `Preview` |
| `PRODUCTION` | Create a production deployment on Vercel and GitHub | **No** | true (false for PR deployments) |
| `DELETE_EXISTING_COMMENT` | Delete existing PR comment when redeploying PR | **No** | true |
| `UPDATE_EXISTING_COMMENT` | Update existing PR comment when redeploying PR | **No** | false |
| `DELETE_EXISTING_COMMENT` | Delete existing PR comment when redeploying PR | **No** | true (ignored if `UPDATE_EXISTING_COMMENT`) |
| `CREATE_COMMENT` | Create PR comment when deploying | **No** | true |
| `ATTACH_COMMIT_METADATA` | Attach metadata about the commit to the Vercel deployment | **No** | true |
| `TRIM_COMMIT_MESSAGE` | When passing meta data to Vercel deployment, trim the commit message to subject only | **No** | false |
Expand Down
6 changes: 5 additions & 1 deletion action.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -31,9 +31,13 @@ inputs:
description: |
Create PR comment when deploying (default: true).
required: false
UPDATE_EXISTING_COMMENT:
description: |
Update existing PR comment when redeploying PR (default: false).
required: false
DELETE_EXISTING_COMMENT:
description: |
Delete existing PR comment when redeploying PR (default: true).
Delete existing PR comment when redeploying PR (default: true, ignored if UPDATE_EXISTING_COMMENT is true).
required: false
ATTACH_COMMIT_METADATA:
description: |
Expand Down
40 changes: 31 additions & 9 deletions dist/index.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -15928,6 +15928,11 @@ const context = {
type: 'boolean',
default: true
}),
UPDATE_EXISTING_COMMENT: parser.getInput({
key: 'UPDATE_EXISTING_COMMENT',
type: 'boolean',
default: false
}),
ATTACH_COMMIT_METADATA: parser.getInput({
key: 'ATTACH_COMMIT_METADATA',
type: 'boolean',
Expand Down Expand Up @@ -16091,16 +16096,20 @@ const init = () => {
return deploymentStatus.data
}

const deleteExistingComment = async () => {
const findExistingComment = async () => {
const { data } = await client.issues.listComments({
owner: USER,
repo: REPOSITORY,
issue_number: PR_NUMBER
})

if (data.length < 1) return
return data.find((comment) =>
comment.body.includes('This pull request has been deployed to Vercel.')
)
}

const comment = data.find((comment) => comment.body.includes('This pull request has been deployed to Vercel.'))
const deleteExistingComment = async () => {
const comment = await findExistingComment()
if (comment) {
await client.issues.deleteComment({
owner: USER,
Expand All @@ -16112,16 +16121,24 @@ const init = () => {
}
}

const createComment = async (body) => {
const createComment = async (body, updateExisting = false) => {
// Remove indentation
const dedented = body.replace(/^[^\S\n]+/gm, '')

const comment = await client.issues.createComment({
const commentParams = {
owner: USER,
repo: REPOSITORY,
issue_number: PR_NUMBER,
body: dedented
})
}

const existingComment = updateExisting ? await findExistingComment() : null
const comment = existingComment ?
await client.issues.updateComment({
comment_id: existingComment.id, ...commentParams
}) :
await client.issues.createComment(commentParams)


return comment.data
}
Expand Down Expand Up @@ -16552,6 +16569,7 @@ const {
PR_LABELS,
CREATE_COMMENT,
DELETE_EXISTING_COMMENT,
UPDATE_EXISTING_COMMENT,
PR_PREVIEW_DOMAIN,
ALIAS_DOMAINS,
ATTACH_COMMIT_METADATA,
Expand Down Expand Up @@ -16648,7 +16666,7 @@ const run = async () => {
}

if (IS_PR) {
if (DELETE_EXISTING_COMMENT) {
if (DELETE_EXISTING_COMMENT && !UPDATE_EXISTING_COMMENT) {
core.info('Checking for existing comment on PR')
const deletedCommentId = await github.deleteExistingComment()

Expand All @@ -16673,13 +16691,17 @@ const run = async () => {
<td><strong>🔍 Inspect:</strong></td>
<td><a href='${ deployment.inspectorUrl }'>${ deployment.inspectorUrl }</a></td>
</tr>
<tr>
<td><strong>🕐 Updated:</strong></td>
<td>${ new Date().toUTCString() }</td>
</tr>
</table>

[View Workflow Logs](${ LOG_URL })
`

const comment = await github.createComment(body)
core.info(`Comment created: ${ comment.html_url }`)
const comment = await github.createComment(body, UPDATE_EXISTING_COMMENT)
core.info(`Commented: ${ comment.html_url }`)
}

if (PR_LABELS) {
Expand Down
5 changes: 5 additions & 0 deletions src/config.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -42,6 +42,11 @@ const context = {
type: 'boolean',
default: true
}),
UPDATE_EXISTING_COMMENT: parser.getInput({
key: 'UPDATE_EXISTING_COMMENT',
type: 'boolean',
default: false
}),
ATTACH_COMMIT_METADATA: parser.getInput({
key: 'ATTACH_COMMIT_METADATA',
type: 'boolean',
Expand Down
24 changes: 18 additions & 6 deletions src/github.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -49,16 +49,20 @@ const init = () => {
return deploymentStatus.data
}

const deleteExistingComment = async () => {
const findExistingComment = async () => {
const { data } = await client.issues.listComments({
owner: USER,
repo: REPOSITORY,
issue_number: PR_NUMBER
})

if (data.length < 1) return
return data.find((comment) =>
comment.body.includes('This pull request has been deployed to Vercel.')
)
}

const comment = data.find((comment) => comment.body.includes('This pull request has been deployed to Vercel.'))
const deleteExistingComment = async () => {
const comment = await findExistingComment()
if (comment) {
await client.issues.deleteComment({
owner: USER,
Expand All @@ -70,16 +74,24 @@ const init = () => {
}
}

const createComment = async (body) => {
const createComment = async (body, updateExisting = false) => {
// Remove indentation
const dedented = body.replace(/^[^\S\n]+/gm, '')

const comment = await client.issues.createComment({
const commentParams = {
owner: USER,
repo: REPOSITORY,
issue_number: PR_NUMBER,
body: dedented
})
}

const existingComment = updateExisting ? await findExistingComment() : null
const comment = existingComment ?
await client.issues.updateComment({
comment_id: existingComment.id, ...commentParams
}) :
await client.issues.createComment(commentParams)


return comment.data
}
Expand Down
11 changes: 8 additions & 3 deletions src/index.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -14,6 +14,7 @@ const {
PR_LABELS,
CREATE_COMMENT,
DELETE_EXISTING_COMMENT,
UPDATE_EXISTING_COMMENT,
PR_PREVIEW_DOMAIN,
ALIAS_DOMAINS,
ATTACH_COMMIT_METADATA,
Expand Down Expand Up @@ -110,7 +111,7 @@ const run = async () => {
}

if (IS_PR) {
if (DELETE_EXISTING_COMMENT) {
if (DELETE_EXISTING_COMMENT && !UPDATE_EXISTING_COMMENT) {
core.info('Checking for existing comment on PR')
const deletedCommentId = await github.deleteExistingComment()

Expand All @@ -135,13 +136,17 @@ const run = async () => {
<td><strong>🔍 Inspect:</strong></td>
<td><a href='${ deployment.inspectorUrl }'>${ deployment.inspectorUrl }</a></td>
</tr>
<tr>
<td><strong>🕐 Updated:</strong></td>
<td>${ new Date().toUTCString() }</td>
</tr>
</table>

[View Workflow Logs](${ LOG_URL })
`

const comment = await github.createComment(body)
core.info(`Comment created: ${ comment.html_url }`)
const comment = await github.createComment(body, UPDATE_EXISTING_COMMENT)
core.info(`Commented: ${ comment.html_url }`)
}

if (PR_LABELS) {
Expand Down