colcon - collective construction
colcon is a command line tool to improve the workflow of building, testing and using multiple software packages. It automates the process, handles the ordering and sets up the environment to use the packages.
The code is open source, and available on GitHub.
The documentation exists in two version:
released: matching the latest released version of all packages
latest: matching the latest state on the default branch of all packages
The documentation is organized into a few sections:
Information about development is also available:
User Documentation
- Installation
- Quick start
- Configuration
- How to
- Show all output immediately on the console
- Show all output on the console after a package has finished
- Build only a single package (or selected packages)
- Build selected packages including their dependencies
- Rebuild packages which depend on a specific package
- Build packages that create a Python C/C++ Extension
- Test selected packages as well as their dependents
- Run specific tests
- Build CMake packages without configuring tests
- CMake packages generating compile_commands.json
- Enable additional output for debugging
- What is a Workspace?
- Log Files
- Isolated vs Merged Workspaces
- Using Multiple Workspaces
- Overriding Packages
Reference
build
- Build Packagesedit
- Edit Filegraph
- Visualize Dependenciesinfo
- Show Package Informationlist
- List Packagesmetadata
- Manage metadatamixin
- Manage mixinstest
- Test Packagestest-result
- Summarize Test Results- Global arguments
- Executor arguments
- Event handler arguments
- Discovery arguments
- Package selection arguments
- Mixin arguments
Developer Documentation
Migrate from other build tools