Skip to content

feat(cleanup)!: replace update-pr-comment with delete-pr-comment#6

Merged
anneschuth merged 1 commit into
mainfrom
feat/cleanup-delete-pr-comment
Feb 2, 2026
Merged

feat(cleanup)!: replace update-pr-comment with delete-pr-comment#6
anneschuth merged 1 commit into
mainfrom
feat/cleanup-delete-pr-comment

Conversation

@robbertbos

Copy link
Copy Markdown
Member

Description

When a PR is closed, the preview deployment is no longer relevant. A strikethrough URL in the comment adds no value - it's just visual noise. Better to simply delete the comment and keep the PR clean.

This aligns with how pr-preview-action works: delete is the default there too.

Old (v1) New (v2)
update-pr-comment: true delete-pr-comment: true
pr-comment-updated output pr-comment-deleted output
Default: false Default: true

Type of Change

  • Breaking change (changes to action inputs/outputs)

Checklist

  • I have tested these changes locally
  • I have updated the documentation (if applicable)
  • My changes follow the existing code style
  • I have added/updated comments where necessary

Breaking Changes

Users upgrading to v2 must replace update-pr-comment with delete-pr-comment.

@anneschuth anneschuth left a comment

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Looks good. This should be merged after all v1.x features and released as v2.0.0. The release workflow already handles creating the v2 major tag. Consider adding a brief migration section to the release notes explaining update-pr-commentdelete-pr-comment.

BREAKING CHANGE: The cleanup action now deletes PR comments instead of
updating them with strikethrough text.

- Rename `update-pr-comment` input to `delete-pr-comment`
- Rename `pr-comment-updated` output to `pr-comment-deleted`
- Change default from `false` to `true` (enabled by default)
- Simplify implementation: delete comment instead of PATCH update

Users upgrading from v1 should replace:
  update-pr-comment: true  →  delete-pr-comment: true

The new default (true) means PR comments are deleted automatically
when cleanup runs, matching the behavior of pr-preview-action.
@anneschuth anneschuth force-pushed the feat/cleanup-delete-pr-comment branch from ef5ecb5 to 372a918 Compare February 2, 2026 11:59
@anneschuth anneschuth merged commit 3ed6122 into main Feb 2, 2026
7 checks passed
@anneschuth anneschuth deleted the feat/cleanup-delete-pr-comment branch February 2, 2026 12:01
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants