Merge pull request #207 from valeros/develop

Add platformio ci command examples with different CI systems.

docs/userguide/cmd_ci.rst

@@ -115,7 +115,7 @@ Shows details about the results of processing environments. More details
 Examples
 --------
 
-1. Integration `Travis.CI <http://travis-ci.org/>`_ for GitHub
+1. Integration `Travis.CI <http://travis-ci.org/>`_, `Shippable <http://shippable.com/>`_ for GitHub
    `USB_Host_Shield_2.0 <https://github.com/felis/USB_Host_Shield_2.0>`_
    project. The ``.travis.yml`` configuration file:
 
@@ -131,6 +131,213 @@ Examples
 
     install:
         - python -c "$(curl -fsSL https://raw.githubusercontent.com/platformio/platformio/master/scripts/get-platformio.py)"
+        - pip install --egg http://sourceforge.net/projects/scons/files/latest/download
+        - wget https://github.com/xxxajk/spi4teensy3/archive/master.zip -O /tmp/spi4teensy3.zip
+        - unzip /tmp/spi4teensy3.zip -d /tmp
 
     script:
-        - platformio ci --lib="." --board=uno --board=teensy31 --board=due
+        - platformio ci --lib="." --lib="/tmp/spi4teensy3-master" --board=uno --board=teensy31 --board=due
+
+2. Integration `CircleCI <http://circleci.com/>`_ for GitHub
+   `USB_Host_Shield_2.0 <https://github.com/felis/USB_Host_Shield_2.0>`_
+   project. The ``circle.yml`` configuration file:
+
+.. code-block:: yaml
+
+    machine:
+
+      environment:
+        PLATFORMIO_CI_SRC: examples/Bluetooth/PS3SPP/PS3SPP.ino
+        PLATFORMIO_CI_SRC: examples/pl2303/pl2303_gps/pl2303_gps.ino
+
+    dependencies:
+      pre:
+        - sudo apt-get install python2.7-dev
+        - sudo python -c "$(curl -fsSL https://raw.githubusercontent.com/platformio/platformio/master/scripts/get-platformio.py)"
+        - sudo pip install --egg http://sourceforge.net/projects/scons/files/latest/download
+        - wget https://github.com/xxxajk/spi4teensy3/archive/master.zip -O /tmp/spi4teensy3.zip
+        - unzip /tmp/spi4teensy3.zip -d /tmp
+    test:
+      override:
+        - platformio ci --lib="." --lib="/tmp/spi4teensy3-master" --board=uno --board=teensy31 --board=due
+
+3. Integration `AppVeyor CI <http://appveyor.com/>`_ for GitHub
+   `USB_Host_Shield_2.0 <https://github.com/felis/USB_Host_Shield_2.0>`_
+   project. The ``appveyor.yml`` configuration file:
+
+.. code-block:: yaml
+
+    build: off
+    environment:
+      global:
+        WITH_COMPILER: "cmd /E:ON /V:ON /C .\\scripts\\appveyor\\run_with_compiler.cmd"
+      matrix:
+        - PLATFORMIO_CI_SRC: "examples\\Bluetooth\\PS3SPP\\PS3SPP.ino"
+          PLATFORMIO_CI_SRC: "examples\\pl2303\\pl2303_gps\\pl2303_gps.ino"
+          WINDOWS_SDK_VERSION: "v7.0"
+          PYTHON_HOME: "C:\\Python27-x64"
+          PYTHON_VERSION: "2.7"
+          PYTHON_ARCH: "64"
+    init:
+      - ps: "ls C:\\Python*"
+    install:
+      - "git submodule update --init --recursive"
+      - "powershell scripts\\appveyor\\install.ps1"
+    before_test:
+      - cmd: SET PATH=%PATH%;%PYTHON_HOME%;%PYTHON_HOME%\Scripts
+      - cmd: git clone https://github.com/xxxajk/spi4teensy3.git c:\spi4teensy
+    test_script:
+      - "%PYTHON_HOME%\\Scripts\\pip --version"
+      - '%WITH_COMPILER% %PYTHON_HOME%\\Scripts\\platformio ci --lib="." --lib="c:\spi4teensy" --board=uno --board=teensy31 --board=due'
+
+The ``run_with_compiler.cmd`` script file:
+
+.. code-block:: none
+
+    @ECHO OFF
+
+    SET COMMAND_TO_RUN=%*
+    SET WIN_SDK_ROOT=C:\Program Files\Microsoft SDKs\Windows
+
+    SET MAJOR_PYTHON_VERSION="%PYTHON_VERSION:~0,1%"
+    IF %MAJOR_PYTHON_VERSION% == "2" (
+        SET WINDOWS_SDK_VERSION="v7.0"
+    ) ELSE IF %MAJOR_PYTHON_VERSION% == "3" (
+        SET WINDOWS_SDK_VERSION="v7.1"
+    ) ELSE (
+        ECHO Unsupported Python version: "%MAJOR_PYTHON_VERSION%"
+        EXIT 1
+    )
+
+    IF "%PYTHON_ARCH%"=="64" (
+        ECHO Configuring Windows SDK %WINDOWS_SDK_VERSION% for Python %MAJOR_PYTHON_VERSION% on a 64 bit architecture
+        SET DISTUTILS_USE_SDK=1
+        SET MSSdk=1
+        "%WIN_SDK_ROOT%\%WINDOWS_SDK_VERSION%\Setup\WindowsSdkVer.exe" -q -version:%WINDOWS_SDK_VERSION%
+        "%WIN_SDK_ROOT%\%WINDOWS_SDK_VERSION%\Bin\SetEnv.cmd" /x64 /release
+        ECHO Executing: %COMMAND_TO_RUN%
+        call %COMMAND_TO_RUN% || EXIT 1
+    ) ELSE (
+        ECHO Using default MSVC build environment for 32 bit architecture
+        ECHO Executing: %COMMAND_TO_RUN%
+        call %COMMAND_TO_RUN% || EXIT 1
+    )
+
+
+The ``install.ps1`` script file:
+
+.. code-block:: none
+
+    $BASE_URL = "https://www.python.org/ftp/python/"
+    $GET_PIP_URL = "https://bootstrap.pypa.io/get-pip.py"
+    $GET_PIP_PATH = "C:\get-pip.py"
+
+
+    function DownloadPython ($python_version, $platform_suffix) {
+        $webclient = New-Object System.Net.WebClient
+        $filename = "python-" + $python_version + $platform_suffix + ".msi"
+        $url = $BASE_URL + $python_version + "/" + $filename
+
+        $basedir = $pwd.Path + "\"
+        $filepath = $basedir + $filename
+        if (Test-Path $filename) {
+            Write-Host "Reusing" $filepath
+            return $filepath
+        }
+
+        # Download and retry up to 5 times in case of network transient errors.
+        Write-Host "Downloading" $filename "from" $url
+        $retry_attempts = 3
+        for($i=0; $i -lt $retry_attempts; $i++){
+            try {
+                $webclient.DownloadFile($url, $filepath)
+                break
+            }
+            Catch [Exception]{
+                Start-Sleep 1
+            }
+       }
+       Write-Host "File saved at" $filepath
+       return $filepath
+    }
+
+
+    function InstallPython ($python_version, $architecture, $python_home) {
+        Write-Host "Installing Python" $python_version "for" $architecture "bit architecture to" $python_home
+        if (Test-Path $python_home) {
+            Write-Host $python_home "already exists, skipping."
+            return $false
+        }
+        if ($architecture -eq "32") {
+            $platform_suffix = ""
+        } else {
+            $platform_suffix = ".amd64"
+        }
+        $filepath = DownloadPython $python_version $platform_suffix
+        Write-Host "Installing" $filepath "to" $python_home
+        $args = "/qn /i $filepath TARGETDIR=$python_home"
+        Write-Host "msiexec.exe" $args
+        Start-Process -FilePath "msiexec.exe" -ArgumentList $args -Wait -Passthru
+        Write-Host "Python $python_version ($architecture) installation complete"
+        return $true
+    }
+
+
+    function InstallPip ($python_home) {
+        $pip_path = $python_home + "/Scripts/pip.exe"
+        $python_path = $python_home + "/python.exe"
+        if (-not(Test-Path $pip_path)) {
+            Write-Host "Installing pip..."
+            $webclient = New-Object System.Net.WebClient
+            $webclient.DownloadFile($GET_PIP_URL, $GET_PIP_PATH)
+            Write-Host "Executing:" $python_path $GET_PIP_PATH
+            Start-Process -FilePath "$python_path" -ArgumentList "$GET_PIP_PATH" -Wait -Passthru
+        } else {
+            Write-Host "pip already installed."
+        }
+    }
+
+    function InstallPackage ($python_home, $pkg) {
+        $pip_path = $python_home + "/Scripts/pip.exe"
+        & $pip_path install $pkg
+    }
+
+    function InstallScons ($python_home) {
+        Write-Host "Start installing Scons"
+        $pip_path = $python_home + "/Scripts/pip.exe"
+        & $pip_path install --egg "http://sourceforge.net/projects/scons/files/latest/download"
+        Write-Host "Scons installed"
+    }
+
+    function main () {
+        InstallPython $env:PYTHON_VERSION $env:PYTHON_ARCH $env:PYTHON_HOME
+        InstallPip $env:PYTHON_HOME
+        InstallPackage $env:PYTHON_HOME setuptools
+        InstallScons $env:PYTHON_HOME
+        InstallPackage $env:PYTHON_HOME "https://github.com/platformio/platformio/archive/develop.zip"
+    }
+
+    main
+
+3. Integration `Drone CI <http://drone.io/>`_ for GitHub
+   `USB_Host_Shield_2.0 <https://github.com/felis/USB_Host_Shield_2.0>`_
+   project. The project settings:
+
+`Environment Variables`:
+
+.. code-block:: none
+
+    PLATFORMIO_CI_SRC=examples/Bluetooth/PS3SPP/PS3SPP.ino
+    PLATFORMIO_CI_SRC=examples/pl2303/pl2303_gps/pl2303_gps.ino
+
+`Commands`:
+
+.. code-block:: none
+
+    pip install --egg http://sourceforge.net/projects/scons/files/latest/download
+    python -c "$(curl -fsSL https://raw.githubusercontent.com/platformio/platformio/master/scripts/get-platformio.py)"
+    wget https://github.com/xxxajk/spi4teensy3/archive/master.zip -O /tmp/spi4teensy3.zip
+    unzip /tmp/spi4teensy3.zip -d /tmp
+    platformio ci --lib="." --lib="/tmp/spi4teensy3-master" --board=uno --board=teensy31 --board=due
+
+