Skip to content

core.info generate unecessary annotations to run summary #87

@caquino

Description

@caquino

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.

  • To implement a new input annotations boolean that allows them to be enabled/disabled
  • Replace core.info by something that does not generate annotations completely

This is the piece of code that needs to be changed:

core.startGroup(`Dependency Snapshot`);
core.info(snapshot.prettyJSON())
core.endGroup();
core.info(`Submitting Snapshot...`)
await submitSnapshot(snapshot);
core.info(`completed.`)

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.

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions