Skip to content

Add a new output "human-readable-output" #327

Open
@teruyamato0731

Description

@teruyamato0731

Describe the request

Add "human-readable-output" to the output of this action, similar to the standard output.
This will make it easier to see the results of the arduino-lint execution in the GitHub workflow summary.

As shown below (this is just an image I created)

- uses: arduino/arduino-lint-action@v1
  id: arduino-lint
- run: echo "${{steps.arduino-lint.outputs.human-readable-output}}" >> $GITHUB_STEP_SUMMARY

Screenshot from 2023-12-07 18-25-33

Describe the current behavior

Currently, the only way is to use "report-file" to output the execution results in json format
However, these are not in human readable format, so the results cannot be easily checked.
Also, although it is possible to check the standard output from the workflow logs to see the execution results in text format, this method requires time and effort to find the execution results in the workflow logs.

'arduino/arduino-lint-action' version

1.0.2

Additional context

Here is the workflow I actually use "arduino/arduino-lint-action".
https://github.com/teruyamato0731/Chassis/actions/runs/7125200953

Using arduino-lint-action is good to notice errors immediately.
However, I use "report-file" to output the results in json format, but rarely actually check the json contents.
I would like to be able to easily see the cause of errors and warnings.

Issue checklist

  • I searched for previous requests in the issue tracker
  • I verified the feature was still missing when using the latest version
  • My request contains all necessary details

Metadata

Metadata

Assignees

No one assigned

    Labels

    topic: codeRelated to content of the project itselftype: enhancementProposed improvement

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions