Skip to content

Commit f9a7a52

Browse files
committed
Linkify readme text where appropriate to provide easy access to supporting information
1 parent f60eebf commit f9a7a52

File tree

1 file changed

+7
-7
lines changed

1 file changed

+7
-7
lines changed

README.md

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@
55
[![Spell Check](https://github.com/arduino/compile-sketches/workflows/Spell%20Check/badge.svg)](https://github.com/arduino/compile-sketches/actions?workflow=Spell+Check)
66
[![codecov](https://codecov.io/gh/arduino/compile-sketches/branch/master/graph/badge.svg)](https://codecov.io/gh/arduino/compile-sketches)
77

8-
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.
99

1010
## Inputs
1111

@@ -25,7 +25,7 @@ If the board is from one of the platforms provided by Arduino's [default package
2525

2626
### `platforms`
2727

28-
YAML-format list of platform dependencies to install.
28+
[YAML](https://en.wikipedia.org/wiki/YAML)-format list of platform dependencies to install.
2929

3030
**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.
3131

@@ -77,7 +77,7 @@ Keys:
7777

7878
### `libraries`
7979

80-
YAML-format list of library dependencies to install.
80+
[YAML](https://en.wikipedia.org/wiki/YAML)-format list of library dependencies to install.
8181

8282
**Default**: `"- source-path: ./"`
8383
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:
124124

125125
### `sketch-paths`
126126

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

129129
**Default**: `"- examples"`
130130

@@ -136,19 +136,19 @@ Set to true to show verbose output in the log.
136136

137137
### `sketches-report-path`
138138

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

141141
**Default**: `"size-deltas-reports"`
142142

143143
### `github-token`
144144

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).
146146

147147
**Default**: `""`
148148

149149
### `enable-deltas-report`
150150

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).
152152

153153
**Default**: `false`
154154

0 commit comments

Comments
 (0)