Prepare 0.1.2 release for arduino_ci v1.2.0

Author: ikatz-drizly

CHANGELOG.md

@@ -11,6 +11,7 @@ and this project adheres to [Semantic Versioning](http://semver.org/).
 - Instructions for testing locally with Docker
 - Adopt new `arduino_ci` version that enables `CUSTOM_INIT_SCRIPT` and `USE_SUBDIR` environment variables
 - Python dependencies for espXX board compilation (unfortunately assumed to be present in image, not installed by board manager)
+- Instructions for new environment variable `SKIP_LIBRARY_PROPERTIES`
 
 ### Changed
 

Dockerfile

@@ -6,10 +6,12 @@ ARG BUILD_REVISION
 ARG BUILD_VERSION
 
 # Values we set in more than one place in this file
-ARG ARDUINO_CI_REPO="https://github.com/ArduinoCI/action"
+ARG ARDUINO_CI_ACTION_REPO="https://github.com/ArduinoCI/action"
 ARG ARDUINO_CI_MAINTAINER="Arduino Continuous Integration <[email protected]>"
-#ARG ARDUINO_CLI_GITREF="tag: 'v1.1.0'"
-ARG ARDUINO_CLI_GITREF="branch: '2020-12-28_wrapup'"
+ARG ARDUINO_CI_GITREPO="https://github.com/ArduinoCI/arduino_ci.git"
+ARG ARDUINO_CI_GITREF="tag: 'v1.2.0'"
+#ARG ARDUINO_CI_GITREPO="https://github.com/ianfixes/arduino_ci.git"
+#ARG ARDUINO_CI_GITREF="branch: '2020-12-28_wrapup'"
 
 LABEL com.github.actions.name="Arduino CI" \
       com.github.actions.description="Unit testing and example compilation for Arduino libraries" \
@@ -20,13 +22,13 @@ LABEL com.github.actions.name="Arduino CI" \
       org.opencontainers.image.revision=$BUILD_REVISION \
       org.opencontainers.image.version=$BUILD_VERSION \
       org.opencontainers.image.authors=$ARDUINO_CI_MAINTAINER \
-      org.opencontainers.image.url=$ARDUINO_CI_REPO \
+      org.opencontainers.image.url=$ARDUINO_CI_ACTION_REPO \
       org.opencontainers.image.source=$ARDUINO_CI_REPO \
-      org.opencontainers.image.documentation=$ARDUINO_CI_REPO \
+      org.opencontainers.image.documentation=$ARDUINO_CI_ACTION_REPO \
       org.opencontainers.image.vendor="Arduino CI" \
       org.opencontainers.image.description="Unit testing and example compilation for Arduino libraries" \
-      repository=$$ARDUINO_CI_REPO \
-      homepage=$ARDUINO_CI_REPO
+      repository=$$ARDUINO_CI_ACTION_REPO \
+      homepage=$ARDUINO_CI_ACTION_REPO
 
 # Values for debugging
 ENV BUILD_DATE=$BUILD_DATE \
@@ -56,7 +58,8 @@ RUN true \
 RUN true \
   && mkdir -p /action/bundle \
   && echo "source 'https://rubygems.org'" > $BUNDLE_GEMFILE \
-  && echo "gem 'arduino_ci', git: 'https://github.com/ianfixes/arduino_ci.git', $ARDUINO_CLI_GITREF" >> $BUNDLE_GEMFILE \
+#  && echo "gem 'arduino_ci', git: '$ARDUINO_CI_GITREPO', $ARDUINO_CI_GITREF" >> $BUNDLE_GEMFILE \
+  && echo "gem 'arduino_ci', '=1.2.0'" >> $BUNDLE_GEMFILE \
   && cat $BUNDLE_GEMFILE \
   && bundle install --gemfile /action/Gemfile --path /action/bundle \
   && find /action |grep arduino_ci.rb

README.md

@@ -7,7 +7,7 @@ This repository is for the **GitHub Action** to run [`arduino_ci`](https://githu
 
 - Contributions to your Arduino library are tested automatically, _without_ the need for hardware present
 - Example sketches in your `examples/` directory are compiled automatically, to detect broken code in the default branch
-
+- `library.properties` is scanned for correctness
 
 ## Adding Arduino CI Pull Request Tests To Your Project
 
@@ -24,7 +24,7 @@ These contents for `.github/workflows/arduino_test_runner.yml` should work for m
 
 ```yml
 ---
-name: Arduino CI
+name: Arduino_CI
 
 on: [pull_request]
 
@@ -34,7 +34,7 @@ jobs:
 
     steps:
       - uses: actions/checkout@v2
-      - uses: Arduino-CI/[email protected].0
+      - uses: Arduino-CI/[email protected].2   # v0.1.2 or the latest version
         env:
           # Not all libraries include examples or unit tests.  The default
           #  behavior of arduino_ci is to assume that "if the files don't
@@ -47,10 +47,20 @@ jobs:
           #  absence of either tests or examples, uncommenting either of
           #  the following lines (as appropriate) will enforce that.
           #
-          EXPECT_EXAMPLES: false
-          EXPECT_UNITTESTS: false
+          # EXPECT_EXAMPLES: false
+          # EXPECT_UNITTESTS: false
+
+          # Scanning library.properties for issues is a relatively new
+          #  feature, and we may not have implemented it perfectly just
+          #  yet.
+          #
+          # If you find that it incorrectly fails your library, you can
+          #  skip it.  (Please open an issue against arduino_ci as well
+          #  so that it can be fixed.)
+          #
+          # SKIP_LIBRARY_PROPERTIES: false
 
-          # Not all libraries are in the root direcotry of a repository.
+          # Not all libraries are in the root directory of a repository.
           # Specifying the path of the library here (relative to the root
           # of the repository) will adjust that.
           #
@@ -76,13 +86,13 @@ jobs:
 You can show Arduino CI status with a badge in your repository `README.md`
 
 ```markdown
-[![Arduino CI](https://github.com/<OWNER>/<REPOSITORY>/workflows/Arduino%20CI/badge.svg)](https://github.com/marketplace/actions/arduino_ci)
+[![Arduino CI](https://github.com/<OWNER>/<REPOSITORY>/workflows/Arduino_CI/badge.svg)](https://github.com/marketplace/actions/arduino_ci)
 ```
 
 > Note that
 > * you must replace `<OWNER>` with your GitHub username
 > * you must replace `<REPOSITORY>` with the name of the GitHub repository
-> * `Arduino%20CI` in the URL must match the `name: Arduino CI` line in the example YAML files above
+> * `Arduino_CI` in the URL must match the `name: Arduino_CI` line in the example YAML files above
 
 
 ## Configuring Behavior of the Arduino CI Test Runner Itself
@@ -97,7 +107,7 @@ For information on Arduino unit testing with `arduino_ci`, see the [`REFERENCE.m
 
 ### Testing Different Arduino Platforms
 
-By default, any unit tests and example sketches are tested against a modest set of Arduino platforms.  This configuration can be overridden in several specific ways; for details, see the [`REFERENCE.md` for Arduino CI's section on CI configuration](https://github.com/Arduino-CI/arduino_ci/blob/master/REFERENCE.md#indirectly-overriding-build-behavior-medium-term-use-and-advanced-options)
+By default, any unit tests and example sketches are tested against a modest set of Arduino platforms.  If you have architectures defined in `library.properties`, that will further refine the set of what is tested.  You can further override this configuration in several specific ways; for details, see the [`REFERENCE.md` for Arduino CI's section on CI configuration](https://github.com/Arduino-CI/arduino_ci/blob/master/REFERENCE.md#indirectly-overriding-build-behavior-medium-term-use-and-advanced-options)
 
 The default configuration is [available in the `arduino_ci` project](https://github.com/Arduino-CI/arduino_ci/blob/master/misc/default.yml), and shows how the platforms and packages are configured (including 3rd-party board provider information).
 
@@ -115,7 +125,7 @@ Path                               |Contents
 `/pathTo/Arduino/libraries/mylib`  | Your library under test, called `mylib`
 `/pathTo/Arduino/libraries/custom` | A custom library
 
-In this situation, you've got a mix of libraries installed locally (the one that will be tested amongst any possible dependencies), and they all work as expected (even though you're not quite sure all of them are up to date, nor whether they have local modifications that aren't part of the official library release.  This setup won't work in CI, but by volume-mounting the libraries directory into the container and using your own library as the working directory, you can ensure that arduino_ci is using the _exact_ same set of dependencies.
+In this situation, you've got a mix of libraries installed locally (the one that will be tested amongst any possible dependencies), and they all work as expected (even though you're not quite sure all of them are up to date, nor whether they have local modifications that aren't part of the official library release).  This setup won't work in CI, but by volume-mounting the libraries directory into the container and using your own library as the working directory, you can ensure that arduino_ci is using the _exact_ same set of dependencies.
 
 > This is also the fastest way to test new versions of dependencies.
 
@@ -168,7 +178,7 @@ docker run --rm \
 ```
 
 
-### Your Arduino Library is a subdirecotry of a monorepo, you need libraries or versions as dependencies that can't be installed by name from the Arduino library manager, you wrote a script to install them automatically
+### Your Arduino Library is a subdirectory of a monorepo, you need libraries or versions as dependencies that can't be installed by name from the Arduino library manager, you wrote a script to install them automatically
 
  Path                                         |Contents
 ----------------------------------------------|--------