Skip to content

Commit 7b01d29

Browse files
committed
Add example companion workflow for creating sketches report workflow artifact to readme
Adding the example workflow to generate the workflow artifact to the arduino/report-size-deltas readme allows the arduino/compile-sketches readme to only demonstrate the basic use of the action without confusing the issue by showing the creation of a workflow artifact that will only be of use to arduino/report-size-deltas users.
1 parent 54b351f commit 7b01d29

File tree

1 file changed

+17
-0
lines changed

1 file changed

+17
-0
lines changed

README.md

+17
Original file line numberDiff line numberDiff line change
@@ -32,3 +32,20 @@ jobs:
3232
steps:
3333
- uses: arduino/report-size-deltas@main
3434
```
35+
36+
This must be used in conjunction with a workflow that runs the [`arduino/compile-sketches`](https://github.com/arduino/compile-sketches) action and uploads the resulting sketches report to a [workflow artifact](https://help.github.com/en/actions/configuring-and-managing-workflows/persisting-workflow-data-using-artifacts):
37+
```yaml
38+
on: [push, pull_request]
39+
jobs:
40+
compile:
41+
runs-on: ubuntu-latest
42+
steps:
43+
- uses: actions/checkout@v2
44+
- uses: arduino/compile-sketches@main
45+
with:
46+
enable-deltas-report: true
47+
- uses: actions/upload-artifact@v2
48+
with:
49+
name: size-deltas-reports
50+
path: size-deltas-reports
51+
```

0 commit comments

Comments
 (0)