This makes maintenance of the compile-examples action a little easier and also makes the documentation more friendly to the users who don't have a need for the size trends report feature.
The sketches report file is used to pass the size data between the compile-examples and report-size-trends actions.
Now that the report is used to transfer data to the report-size-trends action, it's misleading for the report path input name to reference "deltas".
The previous input name (size-deltas-report-folder-name) is still supported. It is now undocumented and a warning will be printed in the workflow log when it is used.
Although no longer an accurate name, the previous default value (size-deltas-reports) is retained to avoid breaking workflows that use the default input value and then reference that path in an actions/upload-artifact step.
It is now the responsibility of the user to provide the logic regarding when the size trends report should be made. Previously, the action only submitted the size trends report on a push to the default branch. Allowing the user to determine when the report should be made makes the action more flexible.
If the default branch of the repository running the workflow is named master, the previous behavior may be achieved by adding this if conditional to the report-size-trends step of the workflow:
Although the compilation testing and report file creation will still work as usual, this is a breaking change for anyone using the size trends feature of the compile-examples action in that the workflow will no longer submit the size trends report. A warning is displayed in the log and on the Actions workflow page for workflows that use the compile-examples action's old size trends API:
::warning::The size trends report feature has been moved to a dedicated action. See the documentation at https://github.com/arduino/actions/tree/report-size-trends-action/libraries/report-size-trends
The compile-examples step of a workflow using the old API to create a size trends report might look like this:
This makes maintenance of the compile-examples action a little easier and also makes the documentation more friendly to the users who don't have a need for the size trends report feature.
The sketches report file is used to pass the size data between the
compile-examplesandreport-size-trendsactions.Now that the report is used to transfer data to the report-size-trends action, it's misleading for the report path input name to reference "deltas".
The previous input name (
size-deltas-report-folder-name) is still supported. It is now undocumented and a warning will be printed in the workflow log when it is used.Although no longer an accurate name, the previous default value (
size-deltas-reports) is retained to avoid breaking workflows that use the default input value and then reference that path in anactions/upload-artifactstep.It is now the responsibility of the user to provide the logic regarding when the size trends report should be made. Previously, the action only submitted the size trends report on a push to the default branch. Allowing the user to determine when the report should be made makes the action more flexible.
If the default branch of the repository running the workflow is named
master, the previous behavior may be achieved by adding thisifconditional to thereport-size-trendsstep of the workflow:Demonstration of the
report-size-trendsactionExisting ArduinoIoTCloud workflow running the version of the
compile-examplesaction from this PR to show backwards compatibilityhttps://github.com/per1234/ArduinoIoTCloud/actions/runs/106831854
Although the compilation testing and report file creation will still work as usual, this is a breaking change for anyone using the size trends feature of the
compile-examplesaction in that the workflow will no longer submit the size trends report. A warning is displayed in the log and on the Actions workflow page for workflows that use thecompile-examplesaction's old size trends API:The compile-examples step of a workflow using the old API to create a size trends report might look like this:
The equivalent workflow steps after this change: