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
+6-6
Original file line number
Diff line number
Diff line change
@@ -94,15 +94,15 @@ $ bundle install --path vendor/bundle # adds packages to local library
94
94
With that installed, just the following shell command each time you want the tests to execute:
95
95
96
96
```
97
-
$ bundle exec arduino_ci_remote.rb
97
+
$ bundle exec arduino_ci.rb
98
98
```
99
99
100
-
`arduino_ci_remote.rb` is the main entry point for this library. This command will iterate over all the library's `examples/` and attempt to compile them. If you set up unit tests, it will run those as well.
100
+
`arduino_ci.rb` is the main entry point for this library. This command will iterate over all the library's `examples/` and attempt to compile them. If you set up unit tests, it will run those as well.
101
101
102
102
103
103
### Reference
104
104
105
-
For more information on the usage of `arduino_ci_remote.rb`, see [REFERENCE.md](REFERENCE.md). It contains information such as:
105
+
For more information on the usage of `arduino_ci.rb`, see [REFERENCE.md](REFERENCE.md). It contains information such as:
106
106
107
107
* How to configure build options (platforms to test, Arduino library dependencies to install) with an `.arduino-ci.yml` file
108
108
* Where to put unit test files
@@ -121,7 +121,7 @@ The following prerequisites must be fulfilled:
121
121
122
122
### Testing with remote CI
123
123
124
-
> **Note:**`arduino_ci_remote.rb` expects to be run from the root directory of your Arduino project library.
124
+
> **Note:**`arduino_ci.rb` expects to be run from the root directory of your Arduino project library.
125
125
126
126
127
127
#### Travis CI
@@ -135,7 +135,7 @@ sudo: false
135
135
language: ruby
136
136
script:
137
137
- bundle install
138
-
- bundle exec arduino_ci_remote.rb
138
+
- bundle exec arduino_ci.rb
139
139
```
140
140
141
141
@@ -149,7 +149,7 @@ Next, you'll need this in `appveyor.yml` in your repo.
Copy file name to clipboardExpand all lines: REFERENCE.md
+5-5
Original file line number
Diff line number
Diff line change
@@ -1,6 +1,6 @@
1
1
# Build / Test Behavior of Arduino CI
2
2
3
-
All tests are run via the same command: `bundle exec arduino_ci_remote.rb`.
3
+
All tests are run via the same command: `bundle exec arduino_ci.rb`.
4
4
5
5
This script is responsible for detecting and runing all unit tests, on every combination of Arduino platform and C++ compiler. This is followed by attempting to detect and build every example on every "default" Arduino platform.
6
6
@@ -11,7 +11,7 @@ These defaults are specified in [misc/default.yml](misc/default.yml). You are f
11
11
12
12
## Directly Overriding Build Behavior (short term use)
13
13
14
-
When testing locally, it's often advantageous to limit the number of tests that are performed to only those tests that relate to the work you're doing; you'll get a faster turnaround time in seeing the results. For a full listing, see `bundle exec arduino_ci_remote.rb --help`.
14
+
When testing locally, it's often advantageous to limit the number of tests that are performed to only those tests that relate to the work you're doing; you'll get a faster turnaround time in seeing the results. For a full listing, see `bundle exec arduino_ci.rb --help`.
15
15
16
16
17
17
### `--skip-unittests` option
@@ -233,14 +233,14 @@ For most build environments, the only script that need be executed by the CI sys
233
233
```shell
234
234
# simplest build script
235
235
bundle install
236
-
bundle exec arduino_ci_remote.rb
236
+
bundle exec arduino_ci.rb
237
237
```
238
238
239
239
However, more flexible usage is available:
240
240
241
241
### Custom Versions of external Arduino Libraries
242
242
243
-
Sometimes you need a fork of an Arduino library instead of the version that will be installed via their GUI. `arduino_ci_remote.rb` won't overwrite existing downloaded libraries with fresh downloads, but it won't fetch the custom versions for you either.
243
+
Sometimes you need a fork of an Arduino library instead of the version that will be installed via their GUI. `arduino_ci.rb` won't overwrite existing downloaded libraries with fresh downloads, but it won't fetch the custom versions for you either.
244
244
245
245
If this is the behavior you need, `ensure_arduino_installation.rb` is for you. It ensures that an Arduino binary is available on the system.
Note the use of subshell to execute `bundle exec arduino_library_location.rb`. This command simply returns the directory in which Arduino Libraries are (or should be) installed.
Copy file name to clipboardExpand all lines: SampleProjects/DoSomething/README.md
+1-1
Original file line number
Diff line number
Diff line change
@@ -34,7 +34,7 @@ At a minimum, you will need the following lines in your file:
34
34
language: ruby
35
35
script:
36
36
- bundle install
37
-
- bundle exec arduino_ci_remote.rb
37
+
- bundle exec arduino_ci.rb
38
38
```
39
39
40
40
This will install the necessary ruby gem, and run it. There are no command line arguments as of this writing, because all configuration is provided by...
0 commit comments