Skip to content

Commit aa6cbae

Browse files
committed
Update documentation to reflect move to new repository
1 parent 2b78b1e commit aa6cbae

File tree

2 files changed

+6
-6
lines changed

2 files changed

+6
-6
lines changed

README.md

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
# libraries/compile-examples action
1+
# arduino/compile-sketches action
22

33
This action checks whether Arduino sketches compile and produces a report of data from the compilations.
44

@@ -110,15 +110,15 @@ Set to true to show verbose output in the log. Default `false`
110110

111111
### `sketches-report-path`
112112

113-
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/actions/libraries/report-size-deltas` and `arduino/actions/libraries/report-size-trends` actions. Default `"size-deltas-reports"`.
113+
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. Default `"size-deltas-reports"`.
114114

115115
### `github-token`
116116

117117
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). Default `""`.
118118

119119
### `enable-deltas-report`
120120

121-
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/actions/libraries/report-size-deltas` action](https://github.com/arduino/actions/tree/master/libraries/report-size-deltas). Default `false`.
121+
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). Default `false`.
122122

123123
### `enable-warnings-report`
124124

@@ -128,7 +128,7 @@ Set to `true` to cause the action to record the compiler warning count for each
128128

129129
Only compiling examples:
130130
```yaml
131-
- uses: arduino/actions/libraries/compile-examples@master
131+
- uses: arduino/compile-sketches@master
132132
with:
133133
fqbn: 'arduino:avr:uno'
134134
libraries: |
@@ -139,7 +139,7 @@ Only compiling examples:
139139

140140
Storing the sketches compilation report report as a [workflow artifact](https://help.github.com/en/actions/configuring-and-managing-workflows/persisting-workflow-data-using-artifacts):
141141
```yaml
142-
- uses: arduino/actions/libraries/compile-examples@master
142+
- uses: arduino/compile-sketches@master
143143
with:
144144
enable-deltas-report: true
145145
- if: github.event_name == 'pull_request'

action.yml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
name: 'Arduino Libraries - Compile Examples'
1+
name: 'Compile Arduino Sketches'
22
description: 'Compiles all the examples included in the library'
33
inputs:
44
cli-version:

0 commit comments

Comments
 (0)