You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Provide a detailed explanation of how the deltas report is produced
Although the user should be able to just set the input to `true` and get deltas, it may sometimes be useful to understand exactly how this data is produced in order to fully understand its meaning.
Copy file name to clipboardExpand all lines: README.md
+7-1Lines changed: 7 additions & 1 deletion
Original file line number
Diff line number
Diff line change
@@ -158,10 +158,16 @@ If the workflow is triggered by a [`push` event](https://docs.github.com/en/acti
158
158
159
159
The deltas will be displayed in the GitHub Actions build log.
160
160
161
-
This may be used with the [`arduino/report-size-deltas` action](https://github.com/arduino/report-size-deltas).
161
+
This report may be used with the [`arduino/report-size-deltas` action](https://github.com/arduino/report-size-deltas).
162
162
163
163
**Default**: `false`
164
164
165
+
#### How it works
166
+
167
+
The sketch is first compiled with the repository in [`$GITHUB_WORKSPACE`](https://docs.github.com/en/actions/configuring-and-managing-workflows/using-environment-variables#default-environment-variables) at the state it was at before the action's step. Data from the compilation is recorded in the sketches report. Next, a [`git checkout`] to the [Git ref](https://git-scm.com/book/en/v2/Git-Internals-Git-References) used as the base of the comparison is done and the compilation + data recording process repeated. The delta is the change in the data between the two compilations.
168
+
169
+
Dependencies defined via the [`libraries`](#libraries) or [`platforms`](#platforms) inputs are installed via [symlinks](https://en.wikipedia.org/wiki/Symbolic_link), meaning dependencies from local paths under `$GITHUB_WORKSPACE` reflect the deltas checkouts even though they are installed outside `$GITHUB_WORKSPACE`.
170
+
165
171
### `enable-warnings-report`
166
172
167
173
Set to `true` to cause the action to record the compiler warning count for each sketch compilation in the sketches report.
0 commit comments