Skip to content

Commit 5ad9eca

Browse files
sebromerosebromero
committed
Add CI workflows
1 parent b26b77c commit 5ad9eca

File tree

5 files changed

+297
-0
lines changed

5 files changed

+297
-0
lines changed

‎.github/workflows/arduino-lint.yml

+28
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,28 @@
1+
name: Arduino Lint
2+
3+
# See: https://docs.github.com/en/free-pro-team@latest/actions/reference/events-that-trigger-workflows
4+
on:
5+
push:
6+
pull_request:
7+
schedule:
8+
# Run every Tuesday at 8 AM UTC to catch breakage caused by new rules added to Arduino Lint.
9+
- cron: "0 8 * * TUE"
10+
workflow_dispatch:
11+
repository_dispatch:
12+
13+
jobs:
14+
lint:
15+
runs-on: ubuntu-latest
16+
17+
steps:
18+
- name: Checkout repository
19+
uses: actions/checkout@v4
20+
21+
- name: Arduino Lint
22+
uses: arduino/arduino-lint-action@v1
23+
with:
24+
compliance: specification
25+
library-manager: submit
26+
# Always use this setting for official repositories. Remove for 3rd party projects.
27+
official: true
28+
project-type: library

‎.github/workflows/compile-examples.yml

+76
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,76 @@
1+
# Source: https://github.com/per1234/.github/blob/main/workflow-templates/compile-examples-private.md
2+
name: Compile Examples
3+
4+
# See: https://docs.github.com/en/actions/reference/events-that-trigger-workflows
5+
on:
6+
push:
7+
paths:
8+
- ".github/workflows/compile-examples.ya?ml"
9+
- "library.properties"
10+
- "examples/**"
11+
- "src/**"
12+
pull_request:
13+
paths:
14+
- ".github/workflows/compile-examples.ya?ml"
15+
- "library.properties"
16+
- "examples/**"
17+
- "src/**"
18+
schedule:
19+
# Run every Tuesday at 8 AM UTC to catch breakage caused by changes to external resources (libraries, platforms).
20+
- cron: "0 8 * * TUE"
21+
workflow_dispatch:
22+
repository_dispatch:
23+
24+
env:
25+
UNIVERSAL_SKETCH_PATHS: |
26+
- examples/AllowDeepSleep
27+
- examples/DeepSleepLockDebug
28+
- examples/Standby
29+
SKETCHES_REPORTS_PATH: sketches-reports
30+
SKETCHES_REPORTS_ARTIFACT_NAME: sketches-reports
31+
32+
jobs:
33+
build:
34+
name: ${{ matrix.board.fqbn }}
35+
runs-on: ubuntu-latest
36+
permissions:
37+
contents: read
38+
pull-requests: read
39+
40+
strategy:
41+
fail-fast: false
42+
43+
matrix:
44+
board:
45+
- fqbn: arduino:mbed_portenta:envie_m7
46+
platforms: |
47+
- name: arduino:mbed_portenta
48+
artifact-name-suffix: arduino-mbed_portenta-envie_m7
49+
50+
steps:
51+
- name: Checkout repository
52+
uses: actions/checkout@v4
53+
54+
- name: Compile examples
55+
uses: arduino/compile-sketches@v1
56+
with:
57+
github-token: ${{ secrets.GITHUB_TOKEN }}
58+
fqbn: ${{ matrix.board.fqbn }}
59+
platforms: ${{ matrix.board.platforms }}
60+
libraries: |
61+
# Install the library from the local path.
62+
- source-path: ./
63+
# Additional library dependencies can be listed here.
64+
# See: https://github.com/arduino/compile-sketches#libraries
65+
sketch-paths: |
66+
${{ env.UNIVERSAL_SKETCH_PATHS }}
67+
${{ matrix.board.additional-sketch-paths }}
68+
enable-deltas-report: true
69+
sketches-report-path: ${{ env.SKETCHES_REPORTS_PATH }}
70+
71+
- name: Save sketches report as workflow artifact
72+
uses: actions/upload-artifact@v4
73+
with:
74+
if-no-files-found: error
75+
name: sketches-report-${{ matrix.board.artifact-name-suffix }}
76+
path: ${{ env.SKETCHES_REPORTS_PATH }}

‎.github/workflows/report-size-deltas.yml

+24
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,24 @@
1+
name: Report Size Deltas
2+
3+
# See: https://docs.github.com/en/free-pro-team@latest/actions/reference/events-that-trigger-workflows
4+
on:
5+
push:
6+
paths:
7+
- ".github/workflows/report-size-deltas.yml"
8+
schedule:
9+
# Run at the minimum interval allowed by GitHub Actions.
10+
# Note: GitHub Actions periodically has outages which result in workflow failures.
11+
# In this event, the workflows will start passing again once the service recovers.
12+
- cron: "*/5 * * * *"
13+
workflow_dispatch:
14+
repository_dispatch:
15+
16+
jobs:
17+
report:
18+
runs-on: ubuntu-latest
19+
steps:
20+
- name: Comment size deltas reports to PRs
21+
uses: arduino/report-size-deltas@v1
22+
with:
23+
# Regex matching the names of the workflow artifacts created by the "Compile Examples" workflow
24+
sketches-reports-source: ^sketches-report-.+

‎.github/workflows/spell-check.yml

+25
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,25 @@
1+
# Source: https://github.com/per1234/.github/blob/main/workflow-templates/spell-check.md
2+
name: Spell Check
3+
4+
# See: https://docs.github.com/en/actions/reference/events-that-trigger-workflows
5+
on:
6+
push:
7+
pull_request:
8+
schedule:
9+
# Run every Tuesday at 8 AM UTC to catch new misspelling detections resulting from dictionary updates.
10+
- cron: "0 8 * * TUE"
11+
workflow_dispatch:
12+
repository_dispatch:
13+
14+
jobs:
15+
spellcheck:
16+
runs-on: ubuntu-latest
17+
permissions:
18+
contents: read
19+
20+
steps:
21+
- name: Checkout repository
22+
uses: actions/checkout@v4
23+
24+
- name: Spell check
25+
uses: codespell-project/actions-codespell@v2

‎.github/workflows/sync-labels.yml

+144
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,144 @@
1+
# Source: https://github.com/arduino/tooling-project-assets/blob/main/workflow-templates/sync-labels.md
2+
name: Sync Labels
3+
4+
# See: https://docs.github.com/actions/using-workflows/events-that-trigger-workflows
5+
on:
6+
push:
7+
paths:
8+
- ".github/workflows/sync-labels.ya?ml"
9+
- ".github/label-configuration-files/*.ya?ml"
10+
pull_request:
11+
paths:
12+
- ".github/workflows/sync-labels.ya?ml"
13+
- ".github/label-configuration-files/*.ya?ml"
14+
schedule:
15+
# Run daily at 8 AM UTC to sync with changes to shared label configurations.
16+
- cron: "0 8 * * *"
17+
workflow_dispatch:
18+
repository_dispatch:
19+
20+
env:
21+
CONFIGURATIONS_FOLDER: .github/label-configuration-files
22+
CONFIGURATIONS_ARTIFACT: label-configuration-files
23+
24+
jobs:
25+
check:
26+
runs-on: ubuntu-latest
27+
permissions:
28+
contents: read
29+
30+
steps:
31+
- name: Checkout repository
32+
uses: actions/checkout@v4
33+
34+
- name: Download JSON schema for labels configuration file
35+
id: download-schema
36+
uses: carlosperate/download-file-action@v2
37+
with:
38+
file-url: https://raw.githubusercontent.com/arduino/tooling-project-assets/main/workflow-templates/assets/sync-labels/arduino-tooling-gh-label-configuration-schema.json
39+
location: ${{ runner.temp }}/label-configuration-schema
40+
41+
- name: Install JSON schema validator
42+
run: |
43+
sudo npm install \
44+
--global \
45+
ajv-cli \
46+
ajv-formats
47+
48+
- name: Validate local labels configuration
49+
run: |
50+
# See: https://github.com/ajv-validator/ajv-cli#readme
51+
ajv validate \
52+
--all-errors \
53+
-c ajv-formats \
54+
-s "${{ steps.download-schema.outputs.file-path }}" \
55+
-d "${{ env.CONFIGURATIONS_FOLDER }}/*.{yml,yaml}"
56+
57+
download:
58+
needs: check
59+
runs-on: ubuntu-latest
60+
permissions: {}
61+
62+
strategy:
63+
matrix:
64+
filename:
65+
# Filenames of the shared configurations to apply to the repository in addition to the local configuration.
66+
# https://github.com/arduino/tooling-project-assets/blob/main/workflow-templates/assets/sync-labels
67+
- universal.yml
68+
69+
steps:
70+
- name: Download
71+
uses: carlosperate/download-file-action@v2
72+
with:
73+
file-url: https://raw.githubusercontent.com/arduino/tooling-project-assets/main/workflow-templates/assets/sync-labels/${{ matrix.filename }}
74+
75+
- name: Pass configuration files to next job via workflow artifact
76+
uses: actions/upload-artifact@v4
77+
with:
78+
path: |
79+
*.yaml
80+
*.yml
81+
if-no-files-found: error
82+
name: ${{ env.CONFIGURATIONS_ARTIFACT }}
83+
84+
sync:
85+
needs: download
86+
runs-on: ubuntu-latest
87+
permissions:
88+
contents: read
89+
issues: write
90+
91+
steps:
92+
- name: Set environment variables
93+
run: |
94+
# See: https://docs.github.com/actions/using-workflows/workflow-commands-for-github-actions#setting-an-environment-variable
95+
echo "MERGED_CONFIGURATION_PATH=${{ runner.temp }}/labels.yml" >> "$GITHUB_ENV"
96+
97+
- name: Determine whether to dry run
98+
id: dry-run
99+
if: >
100+
github.event_name == 'pull_request' ||
101+
(
102+
(
103+
github.event_name == 'push' ||
104+
github.event_name == 'workflow_dispatch'
105+
) &&
106+
github.ref != format('refs/heads/{0}', github.event.repository.default_branch)
107+
)
108+
run: |
109+
# Use of this flag in the github-label-sync command will cause it to only check the validity of the
110+
# configuration.
111+
echo "flag=--dry-run" >> $GITHUB_OUTPUT
112+
113+
- name: Checkout repository
114+
uses: actions/checkout@v4
115+
116+
- name: Download configuration files artifact
117+
uses: actions/download-artifact@v4
118+
with:
119+
name: ${{ env.CONFIGURATIONS_ARTIFACT }}
120+
path: ${{ env.CONFIGURATIONS_FOLDER }}
121+
122+
- name: Remove unneeded artifact
123+
uses: geekyeggo/delete-artifact@v5
124+
with:
125+
name: ${{ env.CONFIGURATIONS_ARTIFACT }}
126+
127+
- name: Merge label configuration files
128+
run: |
129+
# Merge all configuration files
130+
shopt -s extglob
131+
cat "${{ env.CONFIGURATIONS_FOLDER }}"/*.@(yml|yaml) > "${{ env.MERGED_CONFIGURATION_PATH }}"
132+
133+
- name: Install github-label-sync
134+
run: sudo npm install --global github-label-sync
135+
136+
- name: Sync labels
137+
env:
138+
GITHUB_ACCESS_TOKEN: ${{ secrets.GITHUB_TOKEN }}
139+
run: |
140+
# See: https://github.com/Financial-Times/github-label-sync
141+
github-label-sync \
142+
--labels "${{ env.MERGED_CONFIGURATION_PATH }}" \
143+
${{ steps.dry-run.outputs.flag }} \
144+
${{ github.repository }}

0 commit comments

Comments
 (0)