GitLab is a hosted cloud platform that can help you build, test, deploy, and monitor your code from GitLab repositories.
GitLab CI is enabled by default on new projects, so you can start using its
features right away. All you need is pio ci command, a file
called .gitlab-ci.yml (where you describe how the build should run) placed
in the root directory of your git project, and a configured Runner to
perform the actual build (Gitlab has some pre-configured public runners
so your CI script should work out of the box). Each project comes with a
Builds page where you can follow the output of each build, see the commit
that introduced it and other useful information such as the time the build
started, how long it lasted and the commiter’s name. The statuses for each
build are exposed in the GitLab UI, and you can see whether a build
succeeded, failed, got canceled or skipped.
Put .gitlab-ci.yml to the root directory of your repository. The contents of this
file depends on the project you want to add. There are two possible ways of running
PlatformIO in CI services:
This variant is default choice for native PlatformIO projects:
image: python:3.9
cache:
paths:
- ~/.cache/pip
- ~/.platformio/.cache
stages:
- test
before_script:
- "pip install -U platformio"
job:
stage: test
script: "pio run -e <ID_1> -e <ID_2> -e <ID_N>"
This variant is more convenient when project is written as a library (when there are examples or testing code) as it has additional options for specifying extra libraries and boards from command line interface:
image: python:3.9
cache:
paths:
- ~/.cache/pip
- ~/.platformio/.cache
stages:
- test
before_script:
- "pip install -U platformio"
job:
stage: test
script: "pio ci --board=<ID_1> --board=<ID_2> --board=<ID_N>"
variables: {PLATFORMIO_CI_SRC: "path/to/test/file.c"}
Integration for ArduinoJson library
project. The .gitlab-ci.yml configuration file:
image: python:3.9
cache:
paths:
- ~/.cache/pip
- ~/.platformio/.cache
stages:
- test
.job_template: &pio_run
script:
- "pio ci --lib='.' --board=uno --board=teensy31 --board=nodemcuv2 $PLATFORMIO_CI_EXTRA_ARGS"
before_script:
- "pip install -U platformio"
JsonGeneratorExample:
<<: *pio_run
variables:
PLATFORMIO_CI_EXTRA_ARGS: "--board=due"
PLATFORMIO_CI_SRC: examples/JsonGeneratorExample
JsonHttpClient:
<<: *pio_run
variables:
PLATFORMIO_CI_SRC: examples/JsonHttpClient
JsonParserExample:
<<: *pio_run
variables:
PLATFORMIO_CI_SRC: examples/JsonParserExample
JsonServer:
<<: *pio_run
variables:
PLATFORMIO_CI_SRC: examples/JsonServer
JsonUdpBeacon:
<<: *pio_run
variables:
PLATFORMIO_CI_SRC: examples/JsonUdpBeacon
ProgmemExample:
stage: test
<<: *pio_run
variables:
PLATFORMIO_CI_SRC: examples/ProgmemExample
StringExample:
stage: test
<<: *pio_run
variables:
PLATFORMIO_CI_SRC: examples/StringExample