You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: README.md
+29-27
Original file line number
Diff line number
Diff line change
@@ -10,13 +10,14 @@ You want to precisely replicate certain software states in your library, but you
10
10
11
11
You want your Arduino library to be automatically built and tested every time someone contributes code to your project on GitHub, but the Arduino IDE lacks the ability to run unit tests. [Arduino CI](https://github.com/Arduino-CI/arduino_ci) provides that ability.
12
12
13
-
`arduino_ci` is a cross-platform build/test system, consisting of a Ruby gem and a series of C++ mocks. It enables tests to be run both locally and as part of a CI service like Travis or Appveyor. Any OS that can run the Arduino IDE can run `arduino_ci`.
13
+
`arduino_ci` is a cross-platform build/test system, consisting of a Ruby gem and a series of C++ mocks. It enables tests to be run both locally and as part of a CI service like GitHub Actions, TravisCI, Appveyor, etc. Any OS that can run the Arduino IDE can run `arduino_ci`.
Linux | [](https://github.com/Arduino-CI/arduino_ci/actions?workflow=linux)
20
+
Windows | [](https://github.com/Arduino-CI/arduino_ci/actions?workflow=windows)
20
21
21
22
22
23
## Comparison to Other Arduino Testing Tools
@@ -130,6 +131,28 @@ The following prerequisites must be fulfilled:
130
131
> **Note:**`arduino_ci.rb` expects to be run from the root directory of your Arduino project library.
131
132
132
133
134
+
#### GitHub Actions
135
+
136
+
GitHub Actions allows you to automate your workflows directly in GitHub.
137
+
No additional steps are needed.
138
+
Just create a YAML file with the information below in your repo under the `.github/workflows/` directory.
139
+
140
+
```yaml
141
+
on: [push, pull_request]
142
+
jobs:
143
+
runTest:
144
+
runs-on: ubuntu-latest
145
+
steps:
146
+
- uses: actions/checkout@v2
147
+
- uses: ruby/setup-ruby@v1
148
+
with:
149
+
ruby-version: 2.6
150
+
- run: |
151
+
bundle install
152
+
bundle exec arduino_ci_remote.rb
153
+
```
154
+
155
+
133
156
#### Travis CI
134
157
135
158
You'll need to go to https://travis-ci.org/profile/ and enable testing for your Arduino project. Once that happens, you should be all set. The script will test all example projects of the library and all unit tests.
@@ -158,27 +181,6 @@ test_script:
158
181
- bundle exec arduino_ci.rb
159
182
```
160
183
161
-
#### GitHub Actions
162
-
163
-
GitHub Actions allows you to automate your workflows directly in GitHub.
164
-
No additional steps are needed.
165
-
Just create a YAML file with the information below in your repo under the `.github/workflows/` directory.
0 commit comments