GitHub action to run CMake
CMake command options and corresponding action parameters :
| CMake option | Action parameter | Descritpion | Type | Default | Available |
|---|---|---|---|---|---|
| -S | source_dir | Path to root directory of the CMake project to build | path | "./" | ✔️ |
| -B | binary_dir | Path to directory which CMake will use as the root of build directory | path | "../build" | ✔️ |
| -C | initial_cache | Pre-load a script to populate the cache | file | "" | ✔️ |
| -D | variables | Create or update a CMake CACHE entry | array | [] | ✔️ |
| -U | remove_variables | Remove matching entries from CMake CACHE | array | [] | ✔️ |
| -G | generator | Specify a build system generator | string | NMake Makefiles/Unix Makefiles | ✔️ |
| -T | toolset | Toolset specification for the generator, if supported | string | "" | ✔️ |
| -A | platform | Specify platform name if supported by generator | string | "" | ✔️ |
| --toolchain | toolchain | Specify the cross compiling toolchain file | file | "" | ✔️ |
| --install-prefix | install_prefix | Specify the installation directory | path | "" | ✔️ |
| -Wno-dev/-Wdev -Wdeprecated/-Wno-deprecated (CMake3.5+) | configure_warnings | Specify the warnings to print (none, deprecated, warning, developer) | string | "" | ✔️ |
| -Werror=dev/deprecated -Wno-error=dev/deprecated (CMake3.5+) | configure_warnings | The warnings to throw error (none, deprecated, warning, developer) | string | "" | ✔️ |
| --fresh | Perform a fresh configuration of the build tree | ❌ | |||
| -L -LA -LAH | list_cache_variables | List cached variables | string | "none" | ✔️ |
| -N | View mode only | ❌ | |||
| --graphviz | graphviz | Generate graphviz of dependencies | file | "" | ✔️ |
| --system-information | Dump information about this system | ❌ | |||
| --log-level | log_level | Set the log level | string | "" | ✔️ |
| --log-context | log_context | Enable the outputting context attached to each message | bool | ✔️ |
CMake command options and corresponding action parameters :
| CMake option | Action parameter | Description | Type | Default | Available |
|---|---|---|---|---|---|
| --build | binary_dir | Project binary directory to be built | path | "../build" | ✔️ |
| --parallel | parallel | The maximum number of concurrent processes to use when building | int | core available | 3.12+ |
| --target | build_targets | Build targets instead of the default target. Multiple targets may be given, separated by spaces | vector | [] | ✔️ |
| --config | config | For multi-configuration tools, choose configuration | string | "" | ✔️ |
| --clean-first | clean_first | Build target clean first, then build | bool | false | ✔️ |
| --resolve-package-references | resolve_package_references | Resolve remote package references from external package managers (e.g. NuGet) before build | string | "" | ✔️ |
| -v, --verbose | build_verbose | Enable verbose output - if supported - including the build commands to be executed | bool | "" | ✔️ |
| -- | to_native_tool | Pass remaining options to the native tool | vector | [] | ✔️ |
CMake command options and corresponding action parameters :
| CMake option | Action parameter | Description | Type | Default | Available |
|---|---|---|---|---|---|
| --install | binary_dir | Project binary directory to install | path | "../build" | ✔️ |
| --config | config | For multi-configuration generators, choose configuration | string | "" | ✔️ |
| --component | component | Component-based install. Only install component | string | "" | ✔️ |
| --default-directory-permissions | default_directory_permissions | Default directory install permissions | string | "" | 3.19+ |
| --prefix | override_install_prefix | Override the installation prefix | string | "" | 3.15+ |
| --strip | strip | Strip before installing | bool | false | 3.15+ |
| -v, --verbose | install_verbose | Enable verbose output | bool | false | ✔️ |