Creating a GitHub Action to run automated tests (squashed)

Author: prestoncarman

.github/workflows/linux.yaml

@@ -0,0 +1,58 @@
+# This is the name of the workflow, visible on GitHub UI
+name: linux
+
+# Run on a Push or a Pull Request
+on: [push, pull_request]
+
+jobs:
+  rubocop:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v2
+      - uses: ruby/setup-ruby@v1
+        with:
+          ruby-version: 2.6
+
+      # Install and run Arduino CI tests for rubocop
+      - name: Build and Execute
+        run: |
+          g++ -v
+          bundle install
+          bundle exec rubocop --version
+          bundle exec rubocop -D .
+          bundle exec rspec --backtrace
+
+  TestSomething:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v2
+      - uses: ruby/setup-ruby@v1
+        with:
+          ruby-version: 2.6
+
+      # Install and run Arduino CI tests for TestSomething
+      - name: Build and Execute
+        run: |
+          g++ -v
+          bundle install
+          cd SampleProjects/TestSomething
+          bundle install
+          bundle exec arduino_ci.rb
+
+  NetworkLib:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v2
+      - uses: ruby/setup-ruby@v1
+        with:
+          ruby-version: 2.6
+
+      # Install and run Arduino CI tests for NetworkLib
+      - name: Build and Execute
+        run: |
+          g++ -v
+          bundle install
+          cd SampleProjects/NetworkLib
+          ./scripts/install.sh
+          bundle install
+          bundle exec arduino_ci.rb

.github/workflows/windows.yaml

@@ -0,0 +1,58 @@
+# This is the name of the workflow, visible on GitHub UI
+name: windows
+
+# Run on a Push or a Pull Request
+on: [push, pull_request]
+
+jobs:
+  rubocop:
+    runs-on: windows-latest
+    steps:
+      - uses: actions/checkout@v2
+      - uses: ruby/setup-ruby@v1
+        with:
+          ruby-version: 2.6
+
+      # Install and run Arduino CI tests for rubocop
+      - name: Build and Execute
+        run: |
+          g++ -v
+          bundle install
+          bundle exec rubocop --version
+          bundle exec rubocop -D .
+          bundle exec rspec --backtrace
+
+  TestSomething:
+    runs-on: windows-latest
+    steps:
+      - uses: actions/checkout@v2
+      - uses: ruby/setup-ruby@v1
+        with:
+          ruby-version: 2.6
+
+      # Install and run Arduino CI tests for TestSomething
+      - name: Build and Execute
+        run: |
+          g++ -v
+          bundle install
+          cd SampleProjects/TestSomething
+          bundle install
+          bundle exec arduino_ci.rb
+
+  NetworkLib:
+    runs-on: windows-latest
+    steps:
+      - uses: actions/checkout@v2
+      - uses: ruby/setup-ruby@v1
+        with:
+          ruby-version: 2.6
+
+      # Install and run Arduino CI tests for Network
+      - name: Build and Execute
+        run: |
+          g++ -v
+          bundle install
+          cd SampleProjects/NetworkLib
+          bash -x ./scripts/install.sh
+          bundle install
+          bundle exec arduino_ci.rb

CHANGELOG.md

@@ -13,6 +13,8 @@ and this project adheres to [Semantic Versioning](http://semver.org/).
 - Explicit check and warning for library directory names that do not match our guess of what the library should/would be called
 - Symlink tests for `Host`
 - GitHub action for MacOS
+- Add documentation on how to use Arduino CI with GitHub Actions
+- Allow tests to run on GitHub without external set up with GitHub Actions (for Windows and Ubuntu)
 
 ### Changed
 - Arduino backend is now `arduino-cli` version `0.13.0`

README.md

@@ -12,11 +12,11 @@ You want your Arduino library to be automatically built and tested every time so
 
 `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](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)
+              | Linux | macOS | Windows
+-------------------|:------|:------|:--------
+**AppVeyor**       |       |       | [![Windows Build status](https://ci.appveyor.com/api/projects/status/abynv8xd75m26qo9/branch/master?svg=true)](https://ci.appveyor.com/project/ianfixes/arduino-ci)
+**GitHub Actions** | [![Arduino CI](https://github.com/Arduino-CI/arduino_ci/workflows/linux/badge.svg)](https://github.com/Arduino-CI/arduino_ci/actions?workflow=linux) | | [![Arduino CI](https://github.com/Arduino-CI/arduino_ci/workflows/windows/badge.svg)](https://github.com/Arduino-CI/arduino_ci/actions?workflow=windows)
+**Travis CI**      | [![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) | [![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) |
 
 
 ## Comparison to Other Arduino Testing Tools
@@ -158,6 +158,28 @@ test_script:
   - bundle exec arduino_ci.rb
 ```
 
+#### GitHub Actions
+
+GitHub Actions allows you to automate your workflows directly in GitHub.
+No additional steps are needed.
+Just create a YAML file with the information below in your repo under the `.github/workflows/` directory.
+
+```yaml
+on: [push, pull_request]
+jobs:
+  runTest:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v2
+      - uses: ruby/setup-ruby@v1
+        with:
+          ruby-version: 2.6
+      - run: |
+          bundle install
+          bundle exec arduino_ci_remote.rb
+```
+
+
 ## Known Problems
 
 * The Arduino library is not fully mocked.

SampleProjects/NetworkLib/scripts/install.sh

@@ -4,5 +4,5 @@
 # then get the custom one we want to use for testing
 cd $(bundle exec arduino_library_location.rb)
 if [ ! -d ./Ethernet ] ; then
-  git clone https://github.com/Arduino-CI/Ethernet.git
+  git clone --depth 1 https://github.com/Arduino-CI/Ethernet.git
 fi