Add optional branch parameter to install_package and install_library

This allows the user to select which branch of the Git repository they want to install.

Closes #5

Author: per1234

.travis.yml

@@ -50,6 +50,8 @@ before_install:
   - install_package "https://github.com/SpenceKonde/ATTinyCore/archive/master.zip"
   # Test manual package install from Git repository clone
   - install_package "https://github.com/MCUdude/MightyCore.git"
+  # Test manual package install from Git repository clone
+  - install_package "https://github.com/JChristensen/mighty-1284p.git" "v1.6.3"
 
   # Test library installation from repository (can't do this because there is no library in this repository)
   # - install_library
@@ -59,8 +61,12 @@ before_install:
   - install_library "https://github.com/brianc118/MPU9250/archive/master.zip" "MPU9250"
   # Test library install from git repo
   - install_library "https://github.com/sfrwmaker/WirelessOregonV2.git"
+  # Test library install from git repo with branch
+  - install_library "https://github.com/sde1000/NanodeUNIO.git" "master"
   # Test library install from git repo with rename
-  - install_library "https://github.com/mikaelpatel/Arduino-Shell.git" "ArduinoShell"
+  - install_library "https://github.com/mikaelpatel/Arduino-Shell.git" "" "ArduinoShell"
+  # Test library install from git repo with branch and rename
+  - install_library "https://github.com/Avamander/max7456.git" "master" "max_7456"
   # Test set_verbose_output_during_compilation.
   - set_verbose_output_during_compilation "$VERBOSE_COMPILATION"
 
@@ -93,6 +99,8 @@ script:
   # Test board from hardware package manually installed by cloning Git repository
   # Test build_sketch with an IDE version range
   - build_sketch "${APPLICATION_FOLDER}/arduino/examples/01.Basics/BareMinimum/BareMinimum.ino" "MightyCore:avr:1284:pinout=standard,variant=modelP,BOD=2v7,LTO=Os,clock=16MHz_external" "false" "1.8.1" "1.8.2"
+  # Test board from hardware package manually installed by cloning Git repository with non-default branch
+  - build_sketch "${APPLICATION_FOLDER}/arduino/examples/01.Basics/BareMinimum/BareMinimum.ino" "mighty-1284p:avr:avr_developers" "false" "newest"
 
   # Installed library tests:
   # Test build_sketch without absolute path
@@ -104,8 +112,12 @@ script:
   - build_sketch "${SKETCHBOOK_FOLDER}/libraries/NewPing/examples/NewPingExample/NewPingExample.pde" "arduino:avr:uno" "false" "all"
   # Test library installed from .git
   - build_sketch "${SKETCHBOOK_FOLDER}/libraries/WirelessOregonV2/examples/OregonReceiver/OregonReceiver.ino" "arduino:avr:uno" "false" "newest"
+  # Test library installed from .git with branch
+  - build_sketch "${SKETCHBOOK_FOLDER}/libraries/NanodeUNIO/examples/NanodeUNIO_test/NanodeUNIO_test.ino" "arduino:avr:uno" "false" "newest"
   # Test library installed from .git with rename
   - build_sketch "${SKETCHBOOK_FOLDER}/libraries/ArduinoShell/examples/ShellBlink/ShellBlink.ino" "arduino:avr:uno" "false" "newest"
+  # Test library installed from .git with branch and rename
+  - build_sketch "${SKETCHBOOK_FOLDER}/libraries/max_7456/examples/HelloWorld/HelloWorld.ino" "arduino:avr:uno" "false" "newest"
   # Test library installed from Library Manager
   - build_sketch "${SKETCHBOOK_FOLDER}/libraries/Pushetta/examples/simple_notification/simple_notification.ino" "arduino:avr:uno" "false" "newest"
 

README.md

@@ -59,8 +59,13 @@ Install a range of version(s) of the Arduino IDE.
 "Manually" install the hardware package from the current repository. Packages are installed to `$SKETCHBOOK_FOLDER/hardware. Assumes the hardware package is located in the root of the download or repository and has the correct folder structure.
 
 ##### `install_package packageURL`
-"Manually" install a hardware package. Packages are installed to `$SKETCHBOOK_FOLDER/hardware. Assumes the hardware package is located in the root of the download or repository and has the correct folder structure.
-- Parameter: **packageURL** - The URL of the hardware package download or Git repository. The protocol component of the URL (e.g. `http://`, `https://`) is required.
+"Manually" install a hardware package downloaded as a compressed file. Packages are installed to `$SKETCHBOOK_FOLDER/hardware. Assumes the hardware package is located in the root of the file and has the correct folder structure.
+- Parameter: **packageURL** - The URL of the hardware package download. The protocol component of the URL (e.g. `http://`, `https://`) is required.
+
+##### `install_package packageURL [branchName]`
+"Manually" install a hardware package. Packages are installed to `$SKETCHBOOK_FOLDER/hardware. Assumes the hardware package is located in the root of the repository and has the correct folder structure.
+- Parameter: **packageURL** - The URL of the Git repository. The protocol component of the URL (e.g. `http://`, `https://`) is required.
+- Parameter(optional): **branchName** - Branch of the repository to install. If this argument is not specified or is left blank the default branch will be used.
 
 ##### `install_package packageID [packageURL]`
 Install a hardware package using the Arduino IDE (Boards Manager). Only the **Arduino AVR Boards** package is included with the Arduino IDE installation. Packages are installed to `$HOME/.arduino15/packages. You must call `install_ide` before this function. This feature is only available with Arduino IDE 1.6.4 and newer.
@@ -75,9 +80,15 @@ Install a library that is listed in the Arduino Library Manager index. The libra
 - Parameter: **libraryName** - The name of the library to install. You can specify a version separated from the name by a colon, e.g. "LiquidCrystal I2C:1.1.2". If no version is specified the most recent version will be installed. You can also specify comma-separated lists of library names.
 
 ##### `install_library libraryURL [newFolderName]`
-Install a library from a URL (either compressed file download or clone Git repository). The library is installed to the `libraries` subfolder of the sketchbook folder.
-- Parameter: **libraryURL** - The URL of the library download or library name in the Arduino Library Manager. The protocol component of the URL (e.g. `http://`, `https://`) is required. This can be any compressed file format or a .git file will cause that repository to be cloned. Assumes the library is located in the root of the file.
-- Parameter(optional): **newFolderName** - Folder name to rename the installed library folder to. This parameter is only used if the library identifier is a URL (installation from a compressed file or Git repository) This can be useful if the default folder name of the downloaded file is problematic. The Arduino IDE gives include file preference when the filename matches the library folder name. GitHub's "Download ZIP" file is given the folder name {repository name}-{branch name}. Library folder names that contain `-` or `.` are not compatible with Arduino IDE 1.5.6 and older, arduino will hang if it's started with a library using an invalid folder name installed.
+Download a library in a compressed file from a URL. The library is installed to the `libraries` subfolder of the sketchbook folder.
+- Parameter: **libraryURL** - The URL of the library download or library name in the Arduino Library Manager. The protocol component of the URL (e.g. `http://`, `https://`) is required. This can be any compressed file format. Assumes the library is located in the root of the file.
+- Parameter(optional): **newFolderName** - Folder name to rename the installed library folder to. This can be useful if the default folder name of the downloaded file is problematic. The Arduino IDE gives include file preference when the filename matches the library folder name. GitHub's "Download ZIP" file is given the folder name {repository name}-{branch name}. Library folder names that contain `-` or `.` are not compatible with Arduino IDE 1.5.6 and older, arduino will hang if it's started with a library using an invalid folder name installed.
+
+##### `install_library libraryURL [branchName [newFolderName]]`
+Install a library by cloning a Git repository). The library is installed to the `libraries` subfolder of the sketchbook folder.
+- Parameter: **libraryURL** - The URL of the library download or library name in the Arduino Library Manager. The protocol component of the URL (e.g. `http://`, `https://`) is required. Assumes the library is located in the root of the repository.
+- Parameter(optional): **branchName** - Branch of the repository to install. If this argument is not specified or is left blank the default branch will be used.
+- Parameter(optional): **newFolderName** - Folder name to rename the installed library folder to. This can be useful if the default folder name of the downloaded file is problematic. The Arduino IDE gives include file preference when the filename matches the library folder name. Library folder names that contain `-` or `.` are not compatible with Arduino IDE 1.5.6 and older, arduino will hang if it's started with a library using an invalid folder name installed. If the `newFolderName` argument is specified the `branchName` argument must also be specified. If you don't want to specify a branch then use `""` for the `branchName` argument.
 
 ##### `set_verbose_output_during_compilation verboseOutputDuringCompilation`
 Turn on/off arduino verbose output during compilation. This will show all the commands arduino runs during the process rather than just the compiler output. This is usually not very useful output and only clutters up the log.

arduino-ci-script.sh

@@ -377,9 +377,15 @@ function install_package()
 
     if [[ "$packageURL" =~ \.git$ ]]; then
       # Clone the repository
+      local -r branchName="$2"
+
       cd "${ARDUINO_CI_SCRIPT_SKETCHBOOK_FOLDER}/hardware"
-      git clone --quiet "$packageURL"
 
+      if [[ "$branchName" == "" ]]; then
+        git clone --quiet "$packageURL"
+      else
+        git clone --quiet --branch "$branchName" "$packageURL"
+      fi
     else
       cd "$ARDUINO_CI_SCRIPT_TEMPORARY_FOLDER"
 
@@ -452,7 +458,6 @@ function install_library()
   set -o errexit
 
   local -r libraryIdentifier="$1"
-  local -r newFolderName="$2"
 
   # Create the libraries folder if it doesn't already exist
   create_folder "${ARDUINO_CI_SCRIPT_SKETCHBOOK_FOLDER}/libraries"
@@ -463,16 +468,23 @@ function install_library()
     # Note: this assumes the library is in the root of the file
     if [[ "$libraryIdentifier" =~ \.git$ ]]; then
       # Clone the repository
+      local -r branchName="$2"
+      local -r newFolderName="$3"
+
       cd "${ARDUINO_CI_SCRIPT_SKETCHBOOK_FOLDER}/libraries"
-      if [[ "$newFolderName" == "" ]]; then
+
+      if [[ "$branchName" == "" && "$newFolderName" == "" ]]; then
+        git clone --quiet "$libraryIdentifier"
+      elif [[ "$branchName" == "" ]]; then
         git clone --quiet "$libraryIdentifier"
+      elif [[ "$newFolderName" == "" ]]; then
+        git clone --quiet --branch "$branchName" "$libraryIdentifier"
       else
-        git clone --quiet "$libraryIdentifier" "$newFolderName"
+        git clone --quiet --branch "$branchName" "$libraryIdentifier" "$newFolderName"
       fi
-
     else
       # Assume it's a compressed file
-
+      local -r newFolderName="$2"
       # Download the file to the temporary folder
       cd "$ARDUINO_CI_SCRIPT_TEMPORARY_FOLDER"
       # Clean up the temporary folder