Skip to content

Commit d96d755

Browse files
committed
Use appropriate default value for sketches-report-path input
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 `size-deltas-reports` was no longer appropriate and might be the source of confusion. Unfortunately, this is a breaking change for people who: - Did not specify a value to the sketches-report-path input and, - have an additional step in their workflow (e.g., actions/upload-artifact) that relies on the sketches reports being located under the folder resulting from the previous default
1 parent b563173 commit d96d755

File tree

2 files changed

+2
-2
lines changed

2 files changed

+2
-2
lines changed

README.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -174,7 +174,7 @@ Path in which to save a JSON formatted file containing data from the sketch comp
174174

175175
This report is used by the [`arduino/report-size-deltas`](https://github.com/arduino/report-size-deltas) and [`arduino/report-size-trends`](https://github.com/arduino/report-size-trends) actions.
176176

177-
**Default**: `"size-deltas-reports"`
177+
**Default**: `"sketches-reports"`
178178

179179
### `github-token`
180180

action.yml

+1-1
Original file line numberDiff line numberDiff line change
@@ -21,7 +21,7 @@ inputs:
2121
default: false
2222
sketches-report-path:
2323
description: 'Path in which to save a JSON formatted file containing data from the sketch compilations'
24-
default: 'size-deltas-reports'
24+
default: 'sketches-reports'
2525
github-token:
2626
description: 'GitHub access token used to get information from the GitHub API. Only needed if you are using the deltas report feature in a private repository.'
2727
default: ''

0 commit comments

Comments
 (0)