Skip to content

Commit 972ad28

Browse files
author
James Foster
authored
Rename arduino_ci_remote.rb to arduino_ci.rb (#195)
Update old script to call new script.
1 parent 107ec9d commit 972ad28

File tree

9 files changed

+412
-408
lines changed

9 files changed

+412
-408
lines changed

.travis.yml

+1-1
Original file line numberDiff line numberDiff line change
@@ -26,4 +26,4 @@ script:
2626
- bundle exec rspec --backtrace
2727
- cd SampleProjects/TestSomething
2828
- bundle install
29-
- bundle exec arduino_ci_remote.rb
29+
- bundle exec arduino_ci.rb

CHANGELOG.md

+1
Original file line numberDiff line numberDiff line change
@@ -15,6 +15,7 @@ and this project adheres to [Semantic Versioning](http://semver.org/).
1515
- Revise math macros to avoid name clashes
1616

1717
### Deprecated
18+
- Deprecated `arduino_ci_remote.rb` in favor of `arduino_ci.rb`
1819

1920
### Removed
2021

README.md

+6-6
Original file line numberDiff line numberDiff line change
@@ -94,15 +94,15 @@ $ bundle install --path vendor/bundle # adds packages to local library
9494
With that installed, just the following shell command each time you want the tests to execute:
9595

9696
```
97-
$ bundle exec arduino_ci_remote.rb
97+
$ bundle exec arduino_ci.rb
9898
```
9999

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.
101101

102102

103103
### Reference
104104

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:
106106

107107
* How to configure build options (platforms to test, Arduino library dependencies to install) with an `.arduino-ci.yml` file
108108
* Where to put unit test files
@@ -121,7 +121,7 @@ The following prerequisites must be fulfilled:
121121

122122
### Testing with remote CI
123123

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.
125125
126126

127127
#### Travis CI
@@ -135,7 +135,7 @@ sudo: false
135135
language: ruby
136136
script:
137137
- bundle install
138-
- bundle exec arduino_ci_remote.rb
138+
- bundle exec arduino_ci.rb
139139
```
140140
141141
@@ -149,7 +149,7 @@ Next, you'll need this in `appveyor.yml` in your repo.
149149
build: off
150150
test_script:
151151
- bundle install
152-
- bundle exec arduino_ci_remote.rb
152+
- bundle exec arduino_ci.rb
153153
```
154154

155155
## Known Problems

REFERENCE.md

+5-5
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
# Build / Test Behavior of Arduino CI
22

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`.
44

55
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.
66

@@ -11,7 +11,7 @@ These defaults are specified in [misc/default.yml](misc/default.yml). You are f
1111

1212
## Directly Overriding Build Behavior (short term use)
1313

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`.
1515

1616

1717
### `--skip-unittests` option
@@ -233,14 +233,14 @@ For most build environments, the only script that need be executed by the CI sys
233233
```shell
234234
# simplest build script
235235
bundle install
236-
bundle exec arduino_ci_remote.rb
236+
bundle exec arduino_ci.rb
237237
```
238238

239239
However, more flexible usage is available:
240240

241241
### Custom Versions of external Arduino Libraries
242242

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.
244244

245245
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.
246246

@@ -261,7 +261,7 @@ git clone https://repository.com/custom_library_repo.git
261261
mv custom_library_repo $(bundle exec arduino_library_location.rb)
262262
263263
# now run CI
264-
bundle exec arduino_ci_remote.rb
264+
bundle exec arduino_ci.rb
265265
```
266266

267267
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.

SampleProjects/DoSomething/.travis.yml

+1-1
Original file line numberDiff line numberDiff line change
@@ -2,4 +2,4 @@ sudo: false
22
language: ruby
33
script:
44
- bundle install
5-
- bundle exec arduino_ci_remote.rb
5+
- bundle exec arduino_ci.rb

SampleProjects/DoSomething/README.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -34,7 +34,7 @@ At a minimum, you will need the following lines in your file:
3434
language: ruby
3535
script:
3636
- bundle install
37-
- bundle exec arduino_ci_remote.rb
37+
- bundle exec arduino_ci.rb
3838
```
3939
4040
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...

appveyor.yml

+1-1
Original file line numberDiff line numberDiff line change
@@ -24,4 +24,4 @@ test_script:
2424
- bundle exec rspec --backtrace
2525
- cd SampleProjects\TestSomething
2626
- bundle install
27-
- bundle exec arduino_ci_remote.rb
27+
- bundle exec arduino_ci.rb

0 commit comments

Comments
 (0)