search

arduino / report-size-deltas

GitHub Actions action that comments on pull requests with a report of change in memory usage of Arduino sketches
Other
14 stars 8 forks source link

Include warnings-count in report #86

Open tfry-git opened 7 months ago

tfry-git commented 7 months ago

Describe the request

The compile-sketches actions allows the option enable-warnings-report in addition to enable-deltas-report.

Please include that info in the summary posted to PRs. In particular in a matrix build, involving different compilers, it is very useful to spot new (platform specific) warnings, quickly.

Describe the current behavior

This action only posts a readily visible summary of the size-deltas, while - AFAICS - the count of warnings can only be found looking at the action logs itself, which is not very visible, and not very helpful, when dealing with a matrix build.

'arduino/report-size-deltas' version

1

Additional context

No response

Issue checklist

2bndy5 commented 3 months ago

I think this request is more specific to the compile-sketches action. The name of this action (report-size-deltas) does not infer anything about reporting compiler errors/warnings.

It might be easiest to alter compile-sketches action to emit a warning/error message (visible in CI workflow's run summary page), but this idea is incapable of emitting multi-line messages (needed for including the compiler warning/error message).

[!NOTE] Some preliminary research about this feature has been done in arduino/compile-sketches#27

tfry-git commented 3 months ago

You are right, the name report-size-deltas would be off, if this feature was included. OTOH it would still serve a very similar purpose in the development workflow: Automated monitoring of the quality implications of a change / PR. Whatever the naming, it would be useful to a project maintainer to have all such information in one place.

This is the reasoning that led me to file my wish, here.

2bndy5 commented 3 months ago

FYI, the reports (json artifacts) that this actions needs from the compile-sketches action does not include the error/warning info you wish to be reported.

I still think this request is beyond the scope of this action. It seems like you just want an action to post a comment with all the info you want in it.

tfry-git commented 3 months ago

FYI, the reports (json artifacts) that this actions needs from the compile-sketches action does not include the error/warning info you wish to be reported.

They do (if enable-warnings-report is enabled). Example artifact: https://github.com/sensorium/Mozzi/actions/runs/9160671044/artifacts/1519589989 . Abbreviated excerpt for one sketch:

      "board": "arduino:avr:uno",
      "sketches": [
        {
          "name": "examples/01.Basics/Control_Gain",
          "compilation_success": true,
          "sizes": [
            {
              "name": "flash",
              ...
            },
            {
              "name": "RAM for global variables",
              ...
            }
          ],
          "warnings": {
            "current": {
              "absolute": 4
            },
            "previous": {
              "absolute": 7
            },
            "delta": {
              "absolute": -3
            }
          }
        },
        ...
      ]