Skip to content

Fix typos and outdated documentation #4

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 2 commits into from
Sep 10, 2020
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
12 changes: 6 additions & 6 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
# libraries/compile-examples action
# arduino/compile-sketches action

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

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

### `sketches-report-path`

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"`.
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"`.

### `github-token`

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 `""`.

### `enable-deltas-report`

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`.
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`.

### `enable-warnings-report`

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

Only compiling examples:
```yaml
- uses: arduino/actions/libraries/compile-examples@master
- uses: arduino/compile-sketches@master
with:
fqbn: 'arduino:avr:uno'
libraries: |
Expand All @@ -139,12 +139,12 @@ Only compiling examples:

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):
```yaml
- uses: arduino/actions/libraries/compile-examples@master
- uses: arduino/compile-sketches@master
with:
enable-deltas-report: true
- if: github.event_name == 'pull_request'
uses: actions/upload-artifact@v1
with:
name: size-deltas-reports
path: size-delta-reports
path: size-deltas-reports
```
10 changes: 5 additions & 5 deletions action.yml
Original file line number Diff line number Diff line change
@@ -1,8 +1,8 @@
name: 'Arduino Libraries - Compile Examples'
description: 'Compiles all the examples included in the library'
name: 'Compile Arduino Sketches'
description: 'Checks whether Arduino sketches will compile and produces a report of data from the compilations'
inputs:
cli-version:
description: 'Version of arduino-cli to use when builing'
description: 'Version of Arduino CLI to use when building'
default: 'latest'
fqbn:
description: 'Full qualified board name, with Boards Manager URL if needed'
Expand All @@ -14,7 +14,7 @@ inputs:
description: 'YAML-format list of platform dependencies to install'
default: ''
sketch-paths:
description: 'List of paths containing sketches to compile.'
description: 'YAML-format list of paths containing sketches to compile.'
default: '- examples'
verbose:
description: 'Set to true to show verbose output in the log'
Expand All @@ -23,7 +23,7 @@ inputs:
description: 'Path in which to save a JSON formatted file containing data from the sketch compilations'
default: 'size-deltas-reports'
github-token:
description: 'GitHub access token used to get information from the GitHub API. Only needed if you are using the size deltas report feature with a private repository.'
description: 'GitHub access token used to get information from the GitHub API. Only needed if you are using the deltas report feature in a private repository.'
default: ''
enable-deltas-report:
description: 'Set to true to cause the action to determine the change in memory usage and compiler warnings of the compiled sketches between the head and base refs of a PR and the immediate parent commit of a push'
Expand Down