Skip to content

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

Open
aentinger wants to merge 1 commit into
mainfrom
aentinger-patch-1
Open

Add information how to compile individually specified examples only.#98
aentinger wants to merge 1 commit into
mainfrom
aentinger-patch-1

Conversation

@aentinger

Copy link
Copy Markdown
Contributor

No description provided.

@aentinger
aentinger requested a review from per1234 February 2, 2023 08:34
@aentinger aentinger self-assigned this Feb 2, 2023
@MathewHDYT

Copy link
Copy Markdown

@per1234 Would be very nice if this could be merged the additional information that was added helped resolve my issue, when trying to build only specific examples from the folder.

@aentinger

Copy link
Copy Markdown
Contributor Author

Ping @per1234 😁

Comment thread README.md
**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.
```

@2bndy5 2bndy5 Mar 23, 2023

Copy link
Copy Markdown
Contributor

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.

Comment thread README.md

**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
Copy Markdown
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.

Comment thread README.md
Comment on lines +167 to +172
```
sketch-paths: |
- examples/Example-01
- examples/Example-03
- examples/Example-03
```

Copy link
Copy Markdown
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.

Comment thread README.md
sketch-paths: |
- examples/Example-01
- examples/Example-03
- examples/Example-03

Copy link
Copy Markdown
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.

@CLAassistant

Copy link
Copy Markdown

CLA assistant check
Thank you for your submission! We really appreciate it. Like many open source projects, we ask that you sign our Contributor License Agreement before we can accept your contribution.
You have signed the CLA already but the status is still pending? Let us recheck it.

@arduino arduino deleted a comment from CLAassistant Mar 19, 2026
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

5 participants