diff --git a/CHANGELOG.md b/CHANGELOG.md index ea651375..68cc609c 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -9,6 +9,7 @@ and this project adheres to [Semantic Versioning](http://semver.org/). ### Added ### Changed +- Move repository from https://github.com/ianfixes/arduino_ci to https://github.com/Arduino-CI/arduino_ci ### Deprecated @@ -386,30 +387,30 @@ and this project adheres to [Semantic Versioning](http://semver.org/). - Skeleton for gem with working unit tests -[Unreleased]: https://github.com/ianfixes/arduino_ci/compare/v0.3.0...HEAD -[0.3.0]: https://github.com/ianfixes/arduino_ci/compare/v0.2.1...v0.3.0 -[0.2.1]: https://github.com/ianfixes/arduino_ci/compare/v0.2.0...v0.2.1 -[0.2.0]: https://github.com/ianfixes/arduino_ci/compare/v0.1.21...v0.2.0 -[0.1.21]: https://github.com/ianfixes/arduino_ci/compare/v0.1.20...v0.1.21 -[0.1.20]: https://github.com/ianfixes/arduino_ci/compare/v0.1.19...v0.1.20 -[0.1.19]: https://github.com/ianfixes/arduino_ci/compare/v0.1.18...v0.1.19 -[0.1.18]: https://github.com/ianfixes/arduino_ci/compare/v0.1.17...v0.1.18 -[0.1.17]: https://github.com/ianfixes/arduino_ci/compare/v0.1.16...v0.1.17 -[0.1.16]: https://github.com/ianfixes/arduino_ci/compare/v0.1.15...v0.1.16 -[0.1.15]: https://github.com/ianfixes/arduino_ci/compare/v0.1.14...v0.1.15 -[0.1.14]: https://github.com/ianfixes/arduino_ci/compare/v0.1.13...v0.1.14 -[0.1.13]: https://github.com/ianfixes/arduino_ci/compare/v0.1.12...v0.1.13 -[0.1.12]: https://github.com/ianfixes/arduino_ci/compare/v0.1.11...v0.1.12 -[0.1.11]: https://github.com/ianfixes/arduino_ci/compare/v0.1.10...v0.1.11 -[0.1.10]: https://github.com/ianfixes/arduino_ci/compare/v0.1.9...v0.1.10 -[0.1.9]: https://github.com/ianfixes/arduino_ci/compare/v0.1.8...v0.1.9 -[0.1.8]: https://github.com/ianfixes/arduino_ci/compare/v0.1.7...v0.1.8 -[0.1.7]: https://github.com/ianfixes/arduino_ci/compare/v0.1.6...v0.1.7 -[0.1.6]: https://github.com/ianfixes/arduino_ci/compare/v0.1.5...v0.1.6 -[0.1.5]: https://github.com/ianfixes/arduino_ci/compare/v0.1.4...v0.1.5 -[0.1.4]: https://github.com/ianfixes/arduino_ci/compare/v0.1.3...v0.1.4 -[0.1.3]: https://github.com/ianfixes/arduino_ci/compare/v0.1.2...v0.1.3 -[0.1.2]: https://github.com/ianfixes/arduino_ci/compare/v0.1.1...v0.1.2 -[0.1.1]: https://github.com/ianfixes/arduino_ci/compare/v0.1.0...v0.1.1 -[0.1.0]: https://github.com/ianfixes/arduino_ci/compare/v0.0.1...v0.1.0 -[0.0.1]: https://github.com/ianfixes/arduino_ci/compare/v0.0.0...v0.0.1 +[Unreleased]: https://github.com/Arduino-CI/arduino_ci/compare/v0.3.0...HEAD +[0.3.0]: https://github.com/Arduino-CI/arduino_ci/compare/v0.2.1...v0.3.0 +[0.2.1]: https://github.com/Arduino-CI/arduino_ci/compare/v0.2.0...v0.2.1 +[0.2.0]: https://github.com/Arduino-CI/arduino_ci/compare/v0.1.21...v0.2.0 +[0.1.21]: https://github.com/Arduino-CI/arduino_ci/compare/v0.1.20...v0.1.21 +[0.1.20]: https://github.com/Arduino-CI/arduino_ci/compare/v0.1.19...v0.1.20 +[0.1.19]: https://github.com/Arduino-CI/arduino_ci/compare/v0.1.18...v0.1.19 +[0.1.18]: https://github.com/Arduino-CI/arduino_ci/compare/v0.1.17...v0.1.18 +[0.1.17]: https://github.com/Arduino-CI/arduino_ci/compare/v0.1.16...v0.1.17 +[0.1.16]: https://github.com/Arduino-CI/arduino_ci/compare/v0.1.15...v0.1.16 +[0.1.15]: https://github.com/Arduino-CI/arduino_ci/compare/v0.1.14...v0.1.15 +[0.1.14]: https://github.com/Arduino-CI/arduino_ci/compare/v0.1.13...v0.1.14 +[0.1.13]: https://github.com/Arduino-CI/arduino_ci/compare/v0.1.12...v0.1.13 +[0.1.12]: https://github.com/Arduino-CI/arduino_ci/compare/v0.1.11...v0.1.12 +[0.1.11]: https://github.com/Arduino-CI/arduino_ci/compare/v0.1.10...v0.1.11 +[0.1.10]: https://github.com/Arduino-CI/arduino_ci/compare/v0.1.9...v0.1.10 +[0.1.9]: https://github.com/Arduino-CI/arduino_ci/compare/v0.1.8...v0.1.9 +[0.1.8]: https://github.com/Arduino-CI/arduino_ci/compare/v0.1.7...v0.1.8 +[0.1.7]: https://github.com/Arduino-CI/arduino_ci/compare/v0.1.6...v0.1.7 +[0.1.6]: https://github.com/Arduino-CI/arduino_ci/compare/v0.1.5...v0.1.6 +[0.1.5]: https://github.com/Arduino-CI/arduino_ci/compare/v0.1.4...v0.1.5 +[0.1.4]: https://github.com/Arduino-CI/arduino_ci/compare/v0.1.3...v0.1.4 +[0.1.3]: https://github.com/Arduino-CI/arduino_ci/compare/v0.1.2...v0.1.3 +[0.1.2]: https://github.com/Arduino-CI/arduino_ci/compare/v0.1.1...v0.1.2 +[0.1.1]: https://github.com/Arduino-CI/arduino_ci/compare/v0.1.0...v0.1.1 +[0.1.0]: https://github.com/Arduino-CI/arduino_ci/compare/v0.0.1...v0.1.0 +[0.0.1]: https://github.com/Arduino-CI/arduino_ci/compare/v0.0.0...v0.0.1 diff --git a/README.md b/README.md index 5ad418e5..423a8c03 100644 --- a/README.md +++ b/README.md @@ -1,26 +1,26 @@ -# ArduinoCI Ruby gem (`arduino_ci`) [![Gem Version](https://badge.fury.io/rb/arduino_ci.svg)](https://rubygems.org/gems/arduino_ci) [![Documentation](https://img.shields.io/badge/docs-rdoc.info-blue.svg)](https://www.rubydoc.info/gems/arduino_ci/0.3.0) +# ArduinoCI Ruby gem (`arduino_ci`) [![Gem Version](https://badge.fury.io/rb/arduino_ci.svg)](https://rubygems.org/gems/arduino_ci) [![Documentation](http://img.shields.io/badge/docs-rdoc.info-blue.svg)](http://www.rubydoc.info/gems/arduino_ci/0.3.0) You want to run tests on your Arduino library (bonus: without hardware present), but the IDE doesn't support that. Arduino CI provides that ability. You want to precisely replicate certain software states in your library, but you don't have sub-millisecond reflexes for physically faking the inputs, outputs, and serial port. Arduino CI fakes 100% of the physical input and output of an Arduino board, including the clock. -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/ianfixes/arduino_ci) provides that ability. +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. `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`. Platform | CI Status ---------|:--------- -OSX | [![OSX Build Status](https://badges.herokuapp.com/travis/ianfixes/arduino_ci?env=BADGE=osx&label=build&branch=master)](https://travis-ci.org/ianfixes/arduino_ci) -Linux | [![Linux Build Status](https://badges.herokuapp.com/travis/ianfixes/arduino_ci?env=BADGE=linux&label=build&branch=master)](https://travis-ci.org/ianfixes/arduino_ci) -Windows | [![Windows Build status](https://ci.appveyor.com/api/projects/status/8f6e39dea319m83q/branch/master?svg=true)](https://ci.appveyor.com/project/ianfixes/arduino-ci) +OSX | [![OSX Build Status](http://badges.herokuapp.com/travis/Arduino-CI/arduino_ci?env=BADGE=osx&label=build&branch=master)](https://travis-ci.org/Arduino-CI/arduino_ci) +Linux | [![Linux Build Status](http://badges.herokuapp.com/travis/Arduino-CI/arduino_ci?env=BADGE=linux&label=build&branch=master)](https://travis-ci.org/Arduino-CI/arduino_ci) +Windows | [![Windows Build status](https://ci.appveyor.com/api/projects/status/abynv8xd75m26qo9/branch/master?svg=true)](https://ci.appveyor.com/project/ianfixes/arduino-ci) ## Comparison to Other Arduino Testing Tools | Project | CI | Builds Examples | Unittest | Arduino Mocks | Windows | OSX | Linux | License | |-----------------------------------------------------------------------------|:--:|:---------------:|:--------:|:-------------:|:-------:|:---:|:-----:|:--------| -|[ArduinoCI](https://github.com/ianfixes/arduino_ci) | ✅ | ✅ | ✅ | ✅ | ✅ | ✅ | ✅ |Free (Apache-2.0)| +|[ArduinoCI](https://github.com/Arduino-CI/arduino_ci) | ✅ | ✅ | ✅ | ✅ | ✅ | ✅ | ✅ |Free (Apache-2.0)| |[ArduinoUnit](https://github.com/mmurdoch/arduinounit) | ❌ | ❌ | ⚠️ Hardware-based|❌ | ✅ | ✅ | ✅ |Free (MIT)| |[Adafruit `ci-arduino`](https://github.com/adafruit/ci-arduino)| ✅ | ✅ | ❌ | ❌ | ❌ | ❌ | ✅ |Free (MIT)| |[PlatformIO](https://platformio.org) | ✅ | ✅ | ⚠️ Paid only | ❌ | ✅ | ✅ | ✅ |⚠️ EULA| @@ -156,7 +156,7 @@ test_script: * The Arduino library is not fully mocked. * I don't have preprocessor defines for all the Arduino board flavors -* https://github.com/ianfixes/arduino_ci/issues +* https://github.com/Arduino-CI/arduino_ci/issues ## Author @@ -169,4 +169,3 @@ This gem was written by Ian Katz (ianfixes@gmail.com) in 2018. It's released un * [Contributing](CONTRIBUTING.md) * [Adafruit/ci-arduino](https://github.com/adafruit/ci-arduino) which inspired this project * [mmurdoch/arduinounit](https://github.com/mmurdoch/arduinounit) from which the unit test macros were adopted - diff --git a/SampleProjects/DoSomething/library.properties b/SampleProjects/DoSomething/library.properties index be3f3894..48b764c5 100644 --- a/SampleProjects/DoSomething/library.properties +++ b/SampleProjects/DoSomething/library.properties @@ -5,6 +5,6 @@ maintainer=Ian Katz sentence=Arduino CI unit test example paragraph=A skeleton library demonstrating CI and unit tests category=Other -url=https://github.com/ianfixes/arduino_ci/SampleProjects/DoSomething +url=https://github.com/Arduino-CI/arduino_ci/SampleProjects/DoSomething architectures=avr includes=do-something.h diff --git a/SampleProjects/TestSomething/library.properties b/SampleProjects/TestSomething/library.properties index c15e31ff..2d5cbca2 100644 --- a/SampleProjects/TestSomething/library.properties +++ b/SampleProjects/TestSomething/library.properties @@ -5,6 +5,6 @@ maintainer=Ian Katz sentence=Arduino CI unit test example paragraph=A skeleton library demonstrating CI and unit tests category=Other -url=https://github.com/ianfixes/arduino_ci/SampleProjects/TestSomething +url=https://github.com/Arduino-CI/arduino_ci/SampleProjects/TestSomething architectures=avr,esp8266 includes=do-something.h diff --git a/arduino_ci.gemspec b/arduino_ci.gemspec index 992490c4..9b27f138 100644 --- a/arduino_ci.gemspec +++ b/arduino_ci.gemspec @@ -8,11 +8,11 @@ Gem::Specification.new do |spec| spec.version = ArduinoCI::VERSION spec.licenses = ['Apache-2.0'] spec.authors = ["Ian Katz"] - spec.email = ["ianfixes@gmail.com"] + spec.email = ["arduino.continuous.integration@gmail.com"] spec.summary = "Tools for building and unit testing Arduino libraries" spec.description = spec.description - spec.homepage = "http://github.com/ianfixes/arduino_ci" + spec.homepage = "http://github.com/Arduino-CI/arduino_ci" spec.bindir = "exe" rejection_regex = %r{^(test|spec|features)/} diff --git a/lib/arduino_ci/cpp_library.rb b/lib/arduino_ci/cpp_library.rb index 78b98f86..4fbb43d0 100644 --- a/lib/arduino_ci/cpp_library.rb +++ b/lib/arduino_ci/cpp_library.rb @@ -245,7 +245,7 @@ def arduino_library_src_dirs(aux_libraries) subdirs = ["", "src", "utility"] all_aux_include_dirs_nested = aux_libraries.map do |libdir| # library manager coerces spaces in package names to underscores - # see https://github.com/ianfixes/arduino_ci/issues/132#issuecomment-518857059 + # see https://github.com/Arduino-CI/arduino_ci/issues/132#issuecomment-518857059 legal_libdir = libdir.tr(" ", "_") subdirs.map { |subdir| Pathname.new(@arduino_lib_dir) + legal_libdir + subdir } end