Merge pull request #48 from per1234/libraries-input-sources

libraries/compile-examples: add support for all sources to libraries input

Author: aentinger

README.md

@@ -18,7 +18,40 @@ For 3rd party boards, also specify the Boards Manager URL:
 
 ### `libraries`
 
-List of library dependencies to install (space separated). Default `""`.
+YAML-format list of library dependencies to install.
+
+Default `"- source-path: ./"`. This causes the repository to be installed as a library. If there are no library dependencies and you want to override the default, set the `libraries` input to an empty list (`- libraries: '-'`).
+
+Note: the original space-separated list format is also supported. When this syntax is used, the repository under test will always be installed as a library.
+
+#### Sources:
+
+##### Library Manager
+
+Keys:
+- `name` - name of the library.
+- `version` - version of the library to install. Default is the latest version.
+
+##### Local path
+
+Keys:
+- `source-path` - path to install as a library. Relative paths are assumed to be relative to the root of the repository.
+- `destination-name` - folder name to install the library to. By default, the folder will be named according to the source repository or subfolder name.
+
+##### Repository
+
+Keys:
+- `source-url` - URL to clone the repository from. It must start with `git://` or end with `.git`.
+- `version` - [Git ref](https://git-scm.com/book/en/v2/Git-Internals-Git-References) of the repository to checkout. The special version name `latest` will cause the latest tag to be used. By default, the repository will be checked out to the tip of the default branch.
+- `source-path` - path to install as a library. Paths are relative to the root of the repository. The default is to install from the root of the repository.
+- `destination-name` - folder name to install the library to. By default, the folder will be named according to the source repository or subfolder name.
+
+##### Archive download
+
+Keys:
+- `source-url` - download URL for the archive (e.g., `https://github.com/arduino-libraries/Servo/archive/master.zip`).
+- `source-path` - path to install as a library. Paths are relative to the root folder of the archive. If the archive doesn't have a root folder, use `..` as `source-path` to install from the archive root. The default is to install from the root folder of the archive.
+- `destination-name` - folder name to install the library to. By default, the folder will be named according to the source archive or subfolder name.
 
 ### `sketch-paths`
 
@@ -106,6 +139,10 @@ Only compiling examples:
 - uses: arduino/actions/libraries/compile-examples@master
   with:
     fqbn: 'arduino:avr:uno'
+    libraries: |
+      - name: Servo
+      - name: Stepper
+        version: 1.1.3
 ```
 
 Storing the memory usage change report as a [workflow artifact](https://help.github.com/en/actions/configuring-and-managing-workflows/persisting-workflow-data-using-artifacts):

action.yml

@@ -8,8 +8,8 @@ inputs:
     description: 'Full qualified board name, with Boards Manager URL if needed'
     default: 'arduino:avr:uno'
   libraries:
-    description: 'List of library dependencies to install (space separated)'
-    default: ''
+    description: 'YAML-format list of library dependencies to install'
+    default: '- source-path: ./'
   sketch-paths:
     description: 'List of paths containing sketches to compile.'
     default: 'examples'

compilesketches/compilesketches.py

@@ -2,3 +2,4 @@ gitpython==3.1.1
 PyGithub==1.47
 pytest==5.4.1
 pytest-mock==3.1.0
+pyyaml==5.3.1

compilesketches/requirements.txt

@@ -0,0 +1 @@
+foo