Merge pull request #107 from brentru/actions

Actions + Doxygen

Author: ladyada

.github/workflows/githubci.yml

@@ -0,0 +1,61 @@
+name: Arduino Library CI
+
+on: [pull_request, push]
+
+jobs:
+  build:
+    strategy:
+      fail-fast: false
+      matrix:
+        arduino-platform: ["esp8266", "esp32",
+                           "pyportal", "metro_m4_airliftlite"]
+
+    runs-on: ubuntu-latest
+    
+    steps:
+    - uses: actions/setup-python@v1
+      with:
+        python-version: '3.x'
+    - uses: actions/checkout@v2
+    - uses: actions/checkout@v2
+      with:
+         repository: adafruit/ci-arduino
+         path: ci
+
+    - name: pre-install
+      run: bash ci/actions_install.sh
+
+
+    # manually install WiFi
+    - name: extra libraries
+      run: |
+        git clone --quiet https://github.com/adafruit/WiFiNINA.git /home/runner/Arduino/libraries/WiFiNINA
+
+    - name: test platforms
+      run: python3 ci/build_platform.py ${{ matrix.arduino-platform }}
+
+  clang_and_doxy:
+    runs-on: ubuntu-latest
+    needs: build
+    steps:
+    - uses: actions/setup-python@v1
+      with:
+        python-version: '3.x'
+    - uses: actions/checkout@v2
+
+    - uses: actions/checkout@v2
+      with:
+         repository: adafruit/ci-arduino
+         path: ci
+
+    - name: pre-install
+      run: bash ci/actions_install.sh
+
+    - name: clang
+      run: python3 ci/run-clang-format.py -e "ci/*" -e "bin/*" -r . 
+
+    - name: doxygen
+      env:
+        GH_REPO_TOKEN: ${{ secrets.GH_REPO_TOKEN }}
+        PRETTYNAME : "Adafruit IO Arduino Library"
+      run: bash ci/doxy_gen_and_deploy.sh

.gitignore

@@ -12,3 +12,8 @@ platformio.ini
 
 # visual studio code
 .vscode
+
+# Our handy .gitignore for automation ease
+Doxyfile*
+doxygen_sqlite3.db
+html

.travis.yml

@@ -3,4 +3,4 @@ arduino {
   platforms = ["esp8266:esp8266", "esp32:esp32", "adafruit:avr", "arduino:samd", "adafruit:samd"]
   libraries = ["Adafruit MQTT Library", "Adafruit FONA Library", "Ethernet", "WiFi101"]
   boards = ["ESP8266", "M0_WINC1500", "WICED", "MKR1000", "M0_ETHERNETWING", "FONA_32U4", "ESP32"]
-}
+}

Jenkinsfile

@@ -1,17 +1,25 @@
 # Adafruit IO Arduino Library
 
-[![Documentation Status](https://readthedocs.org/projects/adafruit-io-arduino/badge/?version=latest)](https://adafruit-io-arduino.readthedocs.io/en/latest/) [![Build Status](https://travis-ci.com/adafruit/Adafruit_IO_Arduino.svg?branch=master)](https://travis-ci.com/adafruit/Adafruit_IO_Arduino) [![Discord](https://img.shields.io/discord/327254708534116352.svg)](https://discord.gg/nBQh6qu)
+![Build Status](https://github.com/adafruit/Adafruit_IO_Arduino/workflows/Arduino%20Library%20CI/badge.svg)
+
+[![Discord](https://img.shields.io/discord/327254708534116352.svg)](https://discord.gg/nBQh6qu)
 
 ![AIOArduino](https://cdn-learn.adafruit.com/assets/assets/000/057/496/original/adafruit_io_AIOA.png?1531335660)
 
 This library provides a simple device independent interface for interacting with [Adafruit IO](https://io.adafruit.com) using Arduino. It allows you to switch between WiFi (ESP8266, ESP32, AirLift, WINC1500, & WICED), Cellular (32u4 FONA), and Ethernet (Ethernet FeatherWing)
 
-
 ## Documentation
-Documentation including installation, configuration and usage for this library is found on [the Adafruit IO Arduino ReadTheDocs pages](https://adafruit-io-arduino.readthedocs.io/en/latest/).
+
+The Doxygen documentation is automatically generated from the source files
+in this repository, and documents the API exposed by this library.
+
+- [API Documentation](https://adafruit.github.io/Adafruit_IO_Arduino/) (automatically generated via doxygen from source)
 
 ## License
-Copyright (c) 2019 [Adafruit Industries](https://adafruit.com). Licensed under the [MIT license](/LICENSE?raw=true).
 
-[Adafruit](https://adafruit.com) invests time and resources providing this open source code.
-Please support Adafruit and open-source hardware by purchasing products from [Adafruit](https://adafruit.com).
+This open source code is licensed under the MIT license (see [LICENSE](LICENSE)
+for details).
+
+Adafruit invests time and resources providing this open source code, please
+support Adafruit and open-source hardware by purchasing products from
+[Adafruit](https://www.adafruit.com)!