Skip to content

feat: update existing PR summary comment instead of creating new ones#7848

Open
joshjohanning wants to merge 1 commit into
super-linter:mainfrom
joshjohanning:joshjohanning/feat-pr-status-summary-comments
Open

feat: update existing PR summary comment instead of creating new ones#7848
joshjohanning wants to merge 1 commit into
super-linter:mainfrom
joshjohanning:joshjohanning/feat-pr-status-summary-comments

Conversation

@joshjohanning
Copy link
Copy Markdown

@joshjohanning joshjohanning commented May 22, 2026

When ENABLE_GITHUB_PULL_REQUEST_SUMMARY_COMMENT is enabled (it is by default?), super-linter now searches for an existing summary comment (identified by an HTML marker) and updates it in place, rather than creating a new comment on every push. This reduces comment noise / spamminess on pull requests with multiple subsequent pushes.

The implementation:
identify super-linter summary comments

  • Lists existing PR comments and finds any with the marker
  • Updates the existing comment via PATCH if found, or creates a new one
  • Refactors CallGitHubApi to accept an optional HTTP method parameter (backwards-compatible, defaults to POST)

Closes: #7458

I verified that this new logic works in

image

Readiness checklist

In order to have this pull request merged, complete the following tasks.

Pull request author tasks

  • I checked that all workflows return a success.
  • I included all the needed documentation for this change.
  • I provided the necessary tests.
  • I squashed all the commits into a single commit.
  • I followed the
    Conventional Commit v1.0.0 spec.
  • I wrote the necessary upgrade instructions in the
    upgrade guide.
  • If this pull request is about and existing issue, I added the
    Fix #ISSUE_NUMBER or Close #ISSUE_NUMBER text to the description of
    the pull request.

Super-linter maintainer tasks

  • Label as breaking if this change breaks compatibility with the previous
    released version.
  • Label as either: automation, bug, documentation, enhancement,
    infrastructure.
  • Add the pull request to a milestone, eventually creating one, that matches
    with the version that release-please proposes in the
    preview-release-notes CI job.

@joshjohanning joshjohanning force-pushed the joshjohanning/feat-pr-status-summary-comments branch 2 times, most recently from f80c30a to 180b738 Compare May 22, 2026 14:38
When ENABLE_GITHUB_PULL_REQUEST_SUMMARY_COMMENT is enabled, super-linter
now searches for an existing summary comment (identified by an HTML marker)
and updates it in place, rather than creating a new comment on every push.
This reduces comment noise on pull requests with multiple commits.

The implementation:
  identify super-linter summary comments
- Lists existing PR comments and finds any with the marker
- Updates the existing comment via PATCH if found, or creates a new one
- Refactors CallGitHubApi to accept an optional HTTP method parameter
  (backwards-compatible, defaults to POST)

Closes: super-linter#7458
@joshjohanning joshjohanning force-pushed the joshjohanning/feat-pr-status-summary-comments branch from 180b738 to e1ee0a6 Compare May 22, 2026 15:55
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.

write pull request status summary comment edits or deletes old comments

1 participant