Skip to content
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

Make example usage self contained #164

Open
wants to merge 4 commits into
base: main
Choose a base branch
from
Open
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
40 changes: 33 additions & 7 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -241,13 +241,39 @@ Set to `true` to cause the action to record the compiler warning count for each
## Example usage

```yaml
- uses: arduino/compile-sketches@v1
with:
fqbn: "arduino:avr:uno"
libraries: |
- name: Servo
- name: Stepper
version: 1.1.3
# You will see this name in the Actions tab on GitHub
name: Compile Sketches

# Specify conditions for workflow to run
on:
push: # push to main branch
branches:
-main

pull_request: # PR to main branch
branches:
-main

workflow_dispatch: # Manually via button in the Actions tab


# This workflow involves only one job to do, called compile-sketch
jobs:
compile-sketch:
runs-on: ubuntu-latest # runner is latest Github-hosted Ubuntu
steps: # define what steps should be taken
# GA for checking out repo to runner -> https://github.com/actions/checkout
- uses: actions/checkout@v3
# GA for compiling sketches -> https://github.com/arduino/compile-sketches
- uses: arduino/compile-sketches@v1
with:
fqbn: "arduino:avr:uno" # specify fully qualified board name to compile sketches for
libraries: |
# load latest version of Servo library from arduino-libraries org
- name: Servo
# load version 1.1.3 of Stepper library
- name: Stepper #
version: 1.1.3
```

## Additional resources
Expand Down
Loading