Skip to content

Commit 348b1e8

Browse files
committed
Use appropriate default value for sketches-reports-source 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 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.
1 parent 2f05f71 commit 348b1e8

File tree

2 files changed

+4
-4
lines changed

2 files changed

+4
-4
lines changed

README.md

+3-3
Original file line numberDiff line numberDiff line change
@@ -10,7 +10,7 @@ This action comments on the pull request with a report on the resulting change i
1010

1111
### `sketches-reports-source`
1212

13-
**Default**: "size-deltas-reports"
13+
**Default**: "sketches-reports"
1414

1515
The action can be used in two ways:
1616

@@ -68,8 +68,8 @@ jobs:
6868
enable-deltas-report: true
6969
- uses: actions/upload-artifact@v2
7070
with:
71-
name: size-deltas-reports
72-
path: size-deltas-reports
71+
name: sketches-reports
72+
path: sketches-reports
7373
```
7474

7575
### Workflow triggered by `pull_request` event

action.yml

+1-1
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@ description: 'Comments on the pull request with a report on the resulting change
33
inputs:
44
sketches-reports-source:
55
description: 'When run from scheduled workflow, name of the workflow artifact that contains sketches reports. When run from a pull request triggered workflow, path to the folder containing sketches reports.'
6-
default: 'size-deltas-reports'
6+
default: 'sketches-reports'
77
github-token:
88
description: 'GitHub access token used to comment the memory usage comparison results to the PR thread'
99
default: ${{ github.token }}

0 commit comments

Comments
 (0)