Skip to content

Commit 2700ad9

Browse files
committed
Use major version refs in example snippets
Previously, due to the lack of a release, the only option was to use the default branch name for the action refs. Using release versions provides a more stable experience for the ordinary users of these actions and also eases ongoing development work on the actions. Use of the major version ref will cause the workflow to benefit from ongoing development to the action at each patch or minor release up until such time as a new major release is made, at which time the user will be given the opportunity to evaluate whether any changes to the workflow are required by the breaking change that triggered the major release before manually updating the major ref (e.g., `uses: arduino/report-size-deltas@v2`).
1 parent 6162636 commit 2700ad9

File tree

1 file changed

+4
-4
lines changed

1 file changed

+4
-4
lines changed

README.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -69,7 +69,7 @@ jobs:
6969
build:
7070
runs-on: ubuntu-latest
7171
steps:
72-
- uses: arduino/report-size-deltas@main
72+
- uses: arduino/report-size-deltas@v1
7373
```
7474
7575
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):
@@ -80,7 +80,7 @@ jobs:
8080
runs-on: ubuntu-latest
8181
steps:
8282
- uses: actions/checkout@v2
83-
- uses: arduino/compile-sketches@main
83+
- uses: arduino/compile-sketches@v1
8484
with:
8585
enable-deltas-report: true
8686
- uses: actions/upload-artifact@v2
@@ -108,7 +108,7 @@ jobs:
108108
steps:
109109
- uses: actions/checkout@v2
110110
111-
- uses: arduino/compile-sketches@main
111+
- uses: arduino/compile-sketches@v1
112112
with:
113113
fqbn: ${{ matrix.fqbn }}
114114
enable-deltas-report: true
@@ -134,7 +134,7 @@ jobs:
134134
name: ${{ env.SKETCHES_REPORTS_ARTIFACT_NAME }}
135135
path: ${{ env.SKETCHES_REPORTS_PATH }}
136136
137-
- uses: arduino/report-size-deltas@main
137+
- uses: arduino/report-size-deltas@v1
138138
with:
139139
sketches-reports-source: ${{ env.SKETCHES_REPORTS_PATH }}
140140
```

0 commit comments

Comments
 (0)