Skip to content

Add information how to compile individually specified examples only. #98

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.

Sign up for GitHub

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

Open
wants to merge 1 commit into
base: main
Choose a base branch
from
+8 −0
Open

Add information how to compile individually specified examples only. #98

Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
8 changes: 8 additions & 0 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -163,6 +163,14 @@ Keys:

**Default**: `"- examples"`

If you want to specify individual sketches to be compiled, you can do so by passing a multi-line string (a so called [literal block scalar](https://www.yaml.info/learn/quote.html#literal)), i.e.
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I think this information would be better moved to a much needed general explanation of the usage of the action inputs that accept YAML documents. Otherwise the same information would need to be duplicated for the platforms, libraries, and cli-flags inputs as well (#73).

The documentation for each of the individual inputs could then link to that single explanation.

```
Copy link
Contributor

@2bndy5 2bndy5 Mar 23, 2023 •
edited
Loading

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
```
```yml

This will add the syntax highlighting that should be even more helpful. And it aligns with the highlighting of the other code snippets in this doc.

sketch-paths: |
- examples/Example-01
- examples/Example-03
- examples/Example-03
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
- examples/Example-03
- examples/Example-05

The examples/Example-03 path was duplicated.

```
Comment on lines +167 to +172
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
```
sketch-paths: |
- examples/Example-01
- examples/Example-03
- examples/Example-03
```
<details>
<summary><b>Click for an example</b></summary>
<p>
```
sketch-paths: |
- examples/Example-01
- examples/Example-03
- examples/Example-03
```
</p>
</details>

This markup will put the example snippet in a collapsible section that is expanded by the reader on demand with a click:

Click for an example 

sketch-paths: |
  - examples/Example-01
  - examples/Example-03
  - examples/Example-03

The reason I propose this approach is because I think it would be good to add similar examples to the other complex inputs, but such a significant amount of added content can harm the browsability of the readme for those who are looking for a general overview of the action's API.


### `cli-compile-flags`

YAML-format list of flags to add to the Arduino CLI command used to compile the sketches. For the available flags, see [the Arduino CLI command reference](https://arduino.github.io/arduino-cli/latest/commands/arduino-cli_compile/#options).
Expand Down