Use appropriate default value for sketches-reports-source input #7
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
In the time since it was first conceived, the use of the report file created by the compile-sketches action has been expanded from only being a way to pass memory usage change data to the report-size-deltas action to a general purpose report of data generated from the sketch compilations, including: - Non-deltas size data consumed by `arduino/report-size-trends` - Compilation status for each sketch/board combination - Compiler warning count It's possible additional information will be added to the report over time. For this reason, the previous default of the `arduino/compile-sketches` action's `sketches-report-path` input: `size-deltas-reports` was no longer appropriate and had to be changed to avoid confusion. Even though `arduino/report-size-deltas` only uses the deltas data from the report, and so the previous default was somewhat logical, I think it's best for the same default name to be used for the folder and workflow artifacts containing the reports consistently across all the actions that use this report. Unfortunately, this will be a breaking change for people who have not specified the action's `sketches-reports-source` input in their workflow and are thus relying on the default value.
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
In the time since it was first conceived, the use of the report file created by the
arduino/compile-sketchesaction has been expanded from only being a way to pass memory usage change data to thearduino/report-size-deltasaction to a general purpose report of data generated from the sketch compilations, including:arduino/report-size-trendsIt's possible additional information will be added to the report over time.
For this reason, the previous default of the
arduino/compile-sketchesaction'ssketches-report-pathinput:size-deltas-reportswas no longer appropriate and had to be changed to avoid confusion. Even thougharduino/report-size-deltasonly uses the deltas data from the report, and so the previous default was somewhat logical, I think it's best for the same default name to be used for the folder and workflow artifacts containing the reports consistently across all the actions that use this report.Unfortunately, this will be a breaking change for people who have not specified the action's
sketches-reports-sourceinput in their workflow and are thus relying on the default value.