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
This action checks whether Arduino sketches compile and produces a report of data from the compilations.
8
+
This action checks whether [Arduino](https://www.arduino.cc/) sketches compile and produces a report of data from the compilations.
9
9
10
10
## Inputs
11
11
@@ -25,7 +25,7 @@ If the board is from one of the platforms provided by Arduino's [default package
25
25
26
26
### `platforms`
27
27
28
-
YAML-format list of platform dependencies to install.
28
+
[YAML](https://en.wikipedia.org/wiki/YAML)-format list of platform dependencies to install.
29
29
30
30
**Default**: The board's dependency will be automatically determined from the `fqbn` input and the latest version of that platform will be installed via Boards Manager.
31
31
@@ -77,7 +77,7 @@ Keys:
77
77
78
78
### `libraries`
79
79
80
-
YAML-format list of library dependencies to install.
80
+
[YAML](https://en.wikipedia.org/wiki/YAML)-format list of library dependencies to install.
81
81
82
82
**Default**: `"- source-path: ./"`
83
83
This causes the repository to be installed as a library. If there are no library dependencies and you want to override the default, set the `libraries` input to an empty list (`- libraries: '-'`).
@@ -124,7 +124,7 @@ Keys:
124
124
125
125
### `sketch-paths`
126
126
127
-
YAML-format list of paths containing sketches to compile. These paths will be searched recursively.
127
+
[YAML](https://en.wikipedia.org/wiki/YAML)-format list of paths containing sketches to compile. These paths will be searched recursively.
128
128
129
129
**Default**: `"- examples"`
130
130
@@ -136,19 +136,19 @@ Set to true to show verbose output in the log.
136
136
137
137
### `sketches-report-path`
138
138
139
-
Path in which to save a JSON formatted file containing data from the sketch compilations. Should be used only to store reports. Relative paths are relative to [`GITHUB_WORKSPACE`](https://help.github.com/en/actions/configuring-and-managing-workflows/using-environment-variables). The folder will be created if it doesn't already exist. This report is used by the `arduino/report-size-deltas` and `arduino/report-size-trends` actions.
139
+
Path in which to save a JSON formatted file containing data from the sketch compilations. Should be used only to store reports. Relative paths are relative to [`GITHUB_WORKSPACE`](https://help.github.com/en/actions/configuring-and-managing-workflows/using-environment-variables). The folder will be created if it doesn't already exist. 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.
140
140
141
141
**Default**: `"size-deltas-reports"`
142
142
143
143
### `github-token`
144
144
145
-
GitHub access token used to get information from the GitHub API. Only needed for private repositories with `enable-deltas-report` set to `true`. It will be convenient to use [`${{ secrets.GITHUB_TOKEN }}`](https://help.github.com/en/actions/configuring-and-managing-workflows/authenticating-with-the-github_token).
145
+
GitHub access token used to get information from the GitHub API. Only needed for private repositories with [`enable-deltas-report`](#enable-deltas-report) set to `true`. It will be convenient to use [`${{ secrets.GITHUB_TOKEN }}`](https://help.github.com/en/actions/configuring-and-managing-workflows/authenticating-with-the-github_token).
146
146
147
147
**Default**: `""`
148
148
149
149
### `enable-deltas-report`
150
150
151
-
Set to `true` to cause the action to determine the change in memory usage and compiler warnings of the compiled sketches. If the workflow is triggered by a `pull_request` event, the comparison is between the pull request branch and the tip of the pull request's base branch. If the workflow is triggered by a `push` event, the comparison is between the pushed commit and its immediate parent. The deltas will be displayed in the GitHub Actions build log. This may be used with the [`arduino/report-size-deltas` action](https://github.com/arduino/report-size-deltas).
151
+
Set to `true` to cause the action to determine the change in memory usage and compiler warnings of the compiled sketches. If the workflow is triggered by a [`pull_request` event](https://docs.github.com/en/actions/reference/events-that-trigger-workflows#pull_request), the comparison is between the pull request branch and the tip of the pull request's base branch. If the workflow is triggered by a [`push` event](https://docs.github.com/en/actions/reference/events-that-trigger-workflows#push), the comparison is between the pushed commit and its immediate parent. The deltas will be displayed in the GitHub Actions build log. This may be used with the [`arduino/report-size-deltas` action](https://github.com/arduino/report-size-deltas).
0 commit comments