feat!: remove SUCCESS comments from PRs/MRs
#526
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This change removes the `SUCCESS` comments from pull requests (PRs) and merge requests (MRs). Other comment types are unchanged. This change is necessary because the `SUCCESS` comments are considered by existing customers to be too noisy and not useful since the related status check will show as passing when the analyis is successful. Plus, the logs contain the same information as was included in the `SUCCESS` comments. Closes #78 BREAKING CHANGE: PRs/MRs will no longer have `SUCCESS` comments.
maxrake
added a commit
to phylum-dev/phylum-analyze-pr-action
that referenced
this pull request
Jan 13, 2025
This change updates the documentation for the GitHub Action to match the wording provided in phylum-dev/phylum-ci#526.
maxrake
commented
Jan 13, 2025
mhorner-vera
approved these changes
Jan 13, 2025
maxrake
added a commit
to phylum-dev/phylum-analyze-pr-action
that referenced
this pull request
Jan 14, 2025
This change updates the documentation for the GitHub Action to match the wording provided in phylum-dev/phylum-ci#526.
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
This change removes the
SUCCESScomments from pull requests (PRs) and merge requests (MRs). Other comment types are unchanged. This change is necessary because theSUCCESScomments are considered by existing customers to be too noisy and not useful since the related status check will show as passing when the analyis is successful. Plus, the logs contain the same information as was included in theSUCCESScomments.Closes #78
BREAKING CHANGE: PRs/MRs will no longer have
SUCCESScomments.Checklist
closes #<issueNum>in description above)?Testing
The changes in this PR are available for testing with the
maxrake/phylum-ci:quiet_winsDocker image found on Docker Hub.This is what it looks like when a PR is created on GitHub with a lockfile that includes changes where the analysis is successful. Notice there is no comment.
This is what it looks like when the PR is updated to include a known bad dependency:
This is what it looks like when the PR is updated to remove the known bad dependency. Notice that the status check is green and there is no comment.
TODO
phylum-dev/phylum-analyze-pr-actionrepo to account for the documentation updates needed for the GitHub action