| colcon-defaults | Valid JSON content to use as a colcon defaults.yaml file.
Use a pipe to provide a multiline string.
See: https://colcon.readthedocs.io/en/released/user/configuration.html#defaults-yaml
| no | "" |
| colcon-mixin-repository | Mixin repository containing the mixin(s) specified through colcon-defaults or colcon-extra-args | no | https://raw.githubusercontent.com/colcon/colcon-mixin-repository/master/index.yaml |
| coverage-result | Enable code coverage results collection using 'colcon lcov-result' and 'colcon coveragepy-result'.
Depends on 'skip-tests' not being enabled, i.e., tests being run.
Enabled by default; set to 'false' to disable.
| no | true |
| coverage-ignore-pattern | Ignore all files matching this pattern in the coverage report.
It will be injected in the 'colcon lcov-result --filter' option.
Useful for ignoring tests or examples in the coverage report.
| no | "" |
| extra-cmake-args | Additional flags passed to CMake (using colcon build --cmake-args)
| no | "" |
| colcon-extra-args | Arbitrary space-separated additional flags to pass to colcon (build & test).
| no | "" |
| import-token | GitHub personal access token (PAT) to use to import the repository.
Useful if the repo is private.
The PAT should have the "repo" scope.
This currently only works for tokens for the GitHub server this action runs on.
| no | "" |
| package-name | Limit the package(s) to be built and tested.
If left empty this will build and test everything in the workspace - including packages from vcs-repo-file-url imports.
Passing multiple package names is allowed.
Package names can be separated by any whitespace character.
| no | "" |
| target-ros1-distro | ROS 1 distribution to target for the build. Will be used both for
`rosdep install` and `source setup.bash`. Either or both of
`target-ros1-distro` and `target-ros2-distro`, but at least one must
be specified. Typically, both are specified when building packages
that rely on both ROS versions, such as the ros1_bridge.
| no | — |
| target-ros2-distro | ROS 2 distribution to target for the build. Will be used both for
`rosdep install` and `source setup.bash`. Either or both of
`target-ros1-distro` and `target-ros2-distro`, but at least one must
be specified. Typically, both are specified when building packages
that rely on both ROS versions, such as the ros1_bridge.
| no | — |
| vcs-repo-file-url | Repo file URL passed to vcs to initialize the colcon workspace.
The URL may point to a local file, such as file://path/to/file.txt.
For example, for ROS 2 Rolling source repositories, use:
https://raw.githubusercontent.com/ros2/ros2/rolling/ros2.repos
| — | "" |
| skip-tests | Skip tests and code coverage data processing.
Set to 'true'.
| no | "" |
| skip-rosdep-install | Skip rosdep install. This also skips `apt update`/`dnf check-update`.
Set to 'true'.
| no | "" |
| no-symlink-install | Do not use '--symlink-install' with 'colcon build'.
Set to 'true'.
| no | "" |
| rosdep-check | Check dependencies of packages using 'rosdep check'.
Set to 'true'.
| no | "" |
| rosdep-skip-keys | Keys to be skipped when installing dependencies via rosdep.
Passing multiple keys is allowed.
Keys names can be separated by any whitespace character.
| no | "" |
| ref | Branch or reference to checkout via vcstool.
If unset will use the branch from where this action was triggered.
Scheduled events default to latest commit of default branch.
Set this if you want the scheduled job to run on on a specific branch.
| no | "" |
| git-ssh-port | SSH port used to access repositories.
Needed to override the ssh url with https when using a private server
using a non-standard SSH port for git.
| no | "" |