search

advanced-security / maven-dependency-submission-action

GitHub Action for submitting Maven dependencies
MIT License
48 stars 24 forks source link

core.info generate unecessary annotations to run summary #87

Open caquino opened 4 months ago

caquino commented 4 months ago

Hi,

While using this action generates unnecessary annotations to run summary output, which clutters the summary and sometimes causes users to miss other important annotations.

Could this behaviour be configurable, or could the calls to core.info be replaced by something that does not generate annotations?

I'm more than happy to submit a PR with the changes, but I'm curious about which way would be preferred.

This is the piece of code that needs to be changed: https://github.com/advanced-security/maven-dependency-submission-action/blob/f97a4078d80bca790cd68e93a88da11a056ac0a3/src/index.ts#L37-L43

I can see the value of having the pretty print of the snapshot JSON, but it could be replaced by a log file that allows the user to attach it as an artifact to the run summary if desired, or just be printed to console, which can be retrieved from the job raw logs if necessary.

image

As you can see on the snapshot, we use annotations to communicate changes to our reusable workflows to our users, and because of that we try to keep annotations to a minimum.

I have also opened another issue to track this on github/dependency-submission-toolkit as it also generates annotations.

caquino commented 3 weeks ago

Hi, any feedback about this issue? Now that annotations are shown on the top of the step run, this causes even more confusion among users.