Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

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

Open
3 tasks done
teruyamato0731 opened this issue Dec 7, 2023 · 0 comments
Open
3 tasks done

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

teruyamato0731 opened this issue Dec 7, 2023 · 0 comments
Labels
topic: code Related to content of the project itself type: enhancement Proposed improvement

Comments

@teruyamato0731
Copy link

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
@teruyamato0731 teruyamato0731 added the type: enhancement Proposed improvement label Dec 7, 2023
@per1234 per1234 added the topic: code Related to content of the project itself label Dec 7, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
topic: code Related to content of the project itself type: enhancement Proposed improvement
Projects
None yet
Development

No branches or pull requests

2 participants