diff --git a/docs/ci/travis.rst b/docs/ci/travis.rst index ed2df7ce..5322ea5d 100644 --- a/docs/ci/travis.rst +++ b/docs/ci/travis.rst @@ -48,6 +48,13 @@ Please make sure to read Travis CI `Getting Started `_ guides first. +.. note:: + If you are going to use PlatformIO :ref:`unit_testing` or :ref:`pio_remote` + you will need to define :envvar:`PLATFORMIO_AUTH_TOKEN` environment + variable in project settings. See + `Defining Variables in Repository Settings `_ + guide. + PlatformIO is written in Python and is recommended to be run within `Travis CI Python isolated environment `_: @@ -79,7 +86,7 @@ Then perform steps 1, 2 and 4 from http://docs.travis-ci.com/user/getting-starte For more details as for PlatformIO build process please look into :ref:`cmd_ci`. Project as a library -~~~~~~~~~~~~~~~~~~~~ +-------------------- When project is written as a library (where own examples or testing code use it), please use ``--lib="."`` option for :ref:`cmd_ci` command @@ -90,7 +97,7 @@ it), please use ``--lib="."`` option for :ref:`cmd_ci` command - platformio ci --lib="." --board= --board= --board= Library dependencies -~~~~~~~~~~~~~~~~~~~~ +-------------------- There 2 options to test source code with dependent libraries: @@ -124,7 +131,7 @@ Manually download dependent library and include in build process via ``--lib`` o - platformio ci --lib="/tmp/OneWire-master" --board= --board= --board= Custom Build Flags -~~~~~~~~~~~~~~~~~~ +------------------ PlatformIO allows to specify own build flags using :envvar:`PLATFORMIO_BUILD_FLAGS` environment @@ -145,7 +152,7 @@ For the more details, please follow to Advanced configuration -~~~~~~~~~~~~~~~~~~~~~~ +---------------------- PlatformIO allows to configure multiple build environments for the single source code using :ref:`projectconf`. @@ -157,6 +164,11 @@ Instead of ``--board`` option, please use :option:`platformio ci --project-conf` script: - platformio ci --project-conf=/path/to/platoformio.ini +Unit Testing +------------ + +See `PlatformIO Remote Unit Testing Example `_. + Examples -------- diff --git a/docs/plus/unit-testing.rst b/docs/plus/unit-testing.rst index 437f5133..75180e83 100644 --- a/docs/plus/unit-testing.rst +++ b/docs/plus/unit-testing.rst @@ -38,8 +38,8 @@ Demo of `Local & Embedded: Calculator `__. .. _unit_testing_design: @@ -527,6 +528,7 @@ Test results Examples -------- +* `PlatformIO Remote Unit Testing Example `__ * `Embedded: Wiring Blink `_ * `Local & Embedded: Calculator `_