Skip to content

Rename arduino_ci_remote.rb to arduino_ci.rb #195

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

Merged
merged 3 commits into from
Nov 10, 2020
Merged
Show file tree
Hide file tree
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
2 changes: 1 addition & 1 deletion .travis.yml
Original file line number Diff line number Diff line change
Expand Up @@ -26,4 +26,4 @@ script:
- bundle exec rspec --backtrace
- cd SampleProjects/TestSomething
- bundle install
- bundle exec arduino_ci_remote.rb
- bundle exec arduino_ci.rb
1 change: 1 addition & 0 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
Expand Up @@ -13,6 +13,7 @@ and this project adheres to [Semantic Versioning](http://semver.org/).
- Move repository from https://github.com/ianfixes/arduino_ci to https://github.com/Arduino-CI/arduino_ci

### Deprecated
- Deprecated `arduino_ci_remote.rb` in favor of `arduino_ci.rb`

### Removed

Expand Down
12 changes: 6 additions & 6 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -94,15 +94,15 @@ $ bundle install --path vendor/bundle # adds packages to local library
With that installed, just the following shell command each time you want the tests to execute:

```
$ bundle exec arduino_ci_remote.rb
$ bundle exec arduino_ci.rb
```

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


### Reference

For more information on the usage of `arduino_ci_remote.rb`, see [REFERENCE.md](REFERENCE.md). It contains information such as:
For more information on the usage of `arduino_ci.rb`, see [REFERENCE.md](REFERENCE.md). It contains information such as:

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

### Testing with remote CI

> **Note:** `arduino_ci_remote.rb` expects to be run from the root directory of your Arduino project library.
> **Note:** `arduino_ci.rb` expects to be run from the root directory of your Arduino project library.


#### Travis CI
Expand All @@ -135,7 +135,7 @@ sudo: false
language: ruby
script:
- bundle install
- bundle exec arduino_ci_remote.rb
- bundle exec arduino_ci.rb
```


Expand All @@ -149,7 +149,7 @@ Next, you'll need this in `appveyor.yml` in your repo.
build: off
test_script:
- bundle install
- bundle exec arduino_ci_remote.rb
- bundle exec arduino_ci.rb
```

## Known Problems
Expand Down
10 changes: 5 additions & 5 deletions REFERENCE.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# Build / Test Behavior of Arduino CI

All tests are run via the same command: `bundle exec arduino_ci_remote.rb`.
All tests are run via the same command: `bundle exec arduino_ci.rb`.

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.

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

## Directly Overriding Build Behavior (short term use)

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


### `--skip-unittests` option
Expand Down Expand Up @@ -233,14 +233,14 @@ For most build environments, the only script that need be executed by the CI sys
```shell
# simplest build script
bundle install
bundle exec arduino_ci_remote.rb
bundle exec arduino_ci.rb
```

However, more flexible usage is available:

### Custom Versions of external Arduino Libraries

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

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.

Expand All @@ -261,7 +261,7 @@ git clone https://repository.com/custom_library_repo.git
mv custom_library_repo $(bundle exec arduino_library_location.rb)

# now run CI
bundle exec arduino_ci_remote.rb
bundle exec arduino_ci.rb
```

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.
Expand Down
2 changes: 1 addition & 1 deletion SampleProjects/DoSomething/.travis.yml
Original file line number Diff line number Diff line change
Expand Up @@ -2,4 +2,4 @@ sudo: false
language: ruby
script:
- bundle install
- bundle exec arduino_ci_remote.rb
- bundle exec arduino_ci.rb
2 changes: 1 addition & 1 deletion SampleProjects/DoSomething/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -34,7 +34,7 @@ At a minimum, you will need the following lines in your file:
language: ruby
script:
- bundle install
- bundle exec arduino_ci_remote.rb
- bundle exec arduino_ci.rb
```

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...
Expand Down
2 changes: 1 addition & 1 deletion appveyor.yml
Original file line number Diff line number Diff line change
Expand Up @@ -24,4 +24,4 @@ test_script:
- bundle exec rspec --backtrace
- cd SampleProjects\TestSomething
- bundle install
- bundle exec arduino_ci_remote.rb
- bundle exec arduino_ci.rb
Loading