- Notifications
You must be signed in to change notification settings - Fork35
Install all the tools required for building and testing C++ and C projects.
License
aminya/setup-cpp
Folders and files
| Name | Name | Last commit message | Last commit date | |
|---|---|---|---|---|
Repository files navigation
Install all the tools required for building and testing C++/C projects.
Setting up across-platform environment for building and testing C++/C projects is a bit tricky. Each platform has its own compilers, and each of them requires a different installation procedure. This package aims to fix this issue.
setup-cpp can be used locally from terminal, from CI services like GitHub Actions and GitLab Pipelines, and inside containers like Docker.
setup-cpp is supported on many platforms. It is continuously tested on several configurations including Windows (11, 10, 2022, 2019) x64/ARM/x86, Linux (Ubuntu 24.0, 22.04, 20.04, 18.04, Fedora, ArchLinux) x64/ARM64, and macOS (15, 14, 13, 12, 11, 10.15) x64/ARM.setup-cpp is backed by unit tests for each tool and integration tests for compiling cpp projects.
# GitHub Actions example: -name:Setup Cppuses:aminya/setup-cpp@v1with:compiler:llvmvcvarsall:truecmake:trueninja:truevcpkg:true
setup-cpp ismodular and you can choose to install any of these tools:
| category | tools |
|---|---|
| compiler | llvm, gcc, msvc, apple-clang, vcvarsall |
| build system | cmake, ninja, meson, make, task, bazel |
| package manager | vcpkg, conan, choco, brew, nala, git, setup-cpp |
| analyzer/linter | clang-tidy, clang-format, cppcheck, cpplint, flawfinder, lizard, infer, cmakelang, cmake-format, cmake-lint |
| cache | ccache, sccache |
| documentation | doxygen, graphviz |
| coverage | gcovr, opencppcoverage, kcov |
| other | python, powershell, sevenzip |
setup-cpp automatically handles the dependencies of the selected tool (e.g.,python is required forconan).
Runsetup-cpp with the available options.
# Windows example (open PowerShell as admin)npx setup-cpp --compiler llvm --cmaketrue --ninjatrue --ccachetrue --vcpkgtrue# restart the shell to activate the environment
# Linux/Macos examplesudo npx setup-cpp --compiler llvm --cmaketrue --ninjatrue --ccachetrue --vcpkgtruesource~/.cpprc# activate cpp environment variables
NOTE: In thecompiler entry, you can specify the version after- likellvm-18. For the tools, you can pass a specific version instead oftrue that chooses the default version
NOTE: On Unix systems, whensetup-cpp is used locally or in other CI services like GitLab, the environment variables are added to~/.cpprc. You should runsource ~/.cpprc to immediately activate the environment variables. This file is automatically sourced in the next shell restart from~/.bashrc or~/.profile ifSOURCE_CPPRC is not set to0. To deactivate.cpprc in the next shell restart, rename/remove~/.cpprc.
NOTE: On Unix systems, if you are already a root user (e.g., in a GitLab runner or Docker), you will not need to usesudo.
NOTE: setup-cpp requires Nodejs 12 or higher. If Nodejs shipped with your distribution is older than 12, install the latest Node (e.g. forUbuntu 20.04), or alternatively you can use the executables that are self-contained (see the next section).
Download the executable for your platform fromhere, and run it with the available options. You can also automate downloading usingcurl, or other similar tools.
# windows x64curl -o ./setup-cpp.exe -LJ"https://github.com/aminya/setup-cpp/releases/download/v1.1.1/setup-cpp-x64-windows.exe"# linux x64curl -o ./setup-cpp -LJ"https://github.com/aminya/setup-cpp/releases/download/v1.1.1/setup-cpp-x64-linux"# linux arm64curl -o ./setup-cpp -LJ"https://github.com/aminya/setup-cpp/releases/download/v1.1.1/setup-cpp-arm64-linux"# macos arm64curl -o ./setup-cpp -LJ"https://github.com/aminya/setup-cpp/releases/download/v1.1.1/setup-cpp-arm64-macos"# macos x64curl -o ./setup-cpp -LJ"https://github.com/aminya/setup-cpp/releases/download/v1.1.1/setup-cpp-x64-macos"
An example that installs llvm, cmake, ninja, ccache, and vcpkg:
# windows example (open PowerShell as admin)./setup-cpp --compiler llvm --cmaketrue --ninjatrue --ccachetrue --vcpkgtrue# restart the shell to activate the environment
# linux/macos examplechmod +x ./setup-cppsudo ./setup-cpp --compiler llvm --cmaketrue --ninjatrue --ccachetrue --vcpkgtruesource~/.cpprc# activate cpp environment variables
NOTE: On Unix systems, if you are already a root user (e.g., in a GitLab runner or Docker), you will not need to usesudo.
A simple example for building with LLVM, cmake, ninja, vcpkg:
-name:Setup Cppuses:aminya/setup-cpp@v1with:compiler:llvmvcvarsall:truecmake:trueninja:truevcpkg:true
A simple example for installing clang-format for code formatting:
-name:Setup Cppuses:aminya/setup-cpp@v1with:clang-format:true
A complete cross-platform example that tests llvm, gcc, and msvc. It also uses cmake, ninja, vcpkg, and cppcheck.
.github/workflows/ci.yml:
name:cion:pull_request:push:branches: -main -masterjobs:Test:runs-on:${{ matrix.os }}strategy:fail-fast:falsematrix:os: -windows-2022 -ubuntu-24.04 -macos-14# arm64 -macos-13compiler: -llvm -gcc# you can specify the version after `-` like `llvm-18`.include: -os:"windows-2022"compiler:"msvc"steps: -uses:actions/checkout@v3 -name:Cacheuses:actions/cache@v3with:path:| ./build/ ~/vcpkg ~/.cache/vcpkg/archives ${{ env.LOCALAPPDATA }}/vcpkg/archives ${{ env.APPDATA }}/vcpkg/archives ${{ env.XDG_CACHE_HOME }}/vcpkg/archives ~/.cache/ccache ~/.ccache ~/.config/ccache ~/Library/Caches/ccache ${{ env.LOCALAPPDATA }}/ccache ${{ env.XDG_CACHE_HOME }}/ccachekey:${{ runner.os }}-${{ matrix.compiler }}-${{ env.BUILD_TYPE }}-${{ hashFiles('**/CMakeLists.txt', './vcpkg.json') }}restore-keys:| ${{ runner.os }}-${{ env.BUILD_TYPE }}- -name:Setup Cppuses:aminya/setup-cpp@v1with:compiler:${{ matrix.compiler }}vcvarsall:truecmake:trueninja:truevcpkg:truecppcheck:true# instead of `true`, which chooses the default version, you can pass a specific version.
When using thesetup-cpp action in GitHub Actions, by default it will also install thesetup-cpp CLI, which you can use in the subsequent commands. You can modify the default behaviour if needed.
-name:Setup Cppuses:aminya/setup-cpp@v1with:setup-cpp:truenode-package-manager:"npm" -name:Use Setup Cpp CLIrun:setup-cpp --compiler llvm --cmake true --ninja true --ccache true --vcpkg true
To provide fast development environments,setup-cpp provides several prebuilt docker images that have the tools you need. You can use these images as a base image for your project.
The names are in the formataminya/setup-cpp-<platform>:<platform_version>-<setup_cpp_version> andaminya/setup-cpp-<platform>-<compiler>:<platform_version>-<setup_cpp_version>.
Base image withcmake, ninja, task, vcpkg, python, make, cppcheck, gcovr, doxygen, ccache, conan, meson, cmakelang
FROM aminya/setup-cpp-ubuntu:22.04-1.2.2 AS builderImage withllvm and the base tools:
FROM aminya/setup-cpp-ubuntu-llvm:22.04-1.2.2 AS builderImage withgcc and the base tools:
FROM aminya/setup-cpp-ubuntu-gcc:22.04-1.2.2 AS builderImage withmingw and the base tools:
FROM aminya/setup-cpp-ubuntu-mingw:22.04-1.2.2 AS builderBase image withcmake, ninja, task, vcpkg, python, make, cppcheck, gcovr, doxygen, ccache, conan, meson, cmakelang
FROM aminya/setup-cpp-fedora:40-1.2.2 AS builderImage withllvm and the base tools:
FROM aminya/setup-cpp-fedora-llvm:40-1.2.2 AS builderImage withgcc and the base tools:
FROM aminya/setup-cpp-fedora-gcc:40-1.2.2 AS builderImage withmingw and the base tools:
FROM aminya/setup-cpp-fedora-mingw:40-1.2.2 AS builderBase image withcmake, ninja, task, vcpkg, python, make, cppcheck, gcovr, doxygen, ccache, conan, meson, cmakelang
FROM aminya/setup-cpp-arch:base-1.2.2 AS builderImage withllvm and the base tools:
FROM aminya/setup-cpp-arch-llvm:base-1.2.2 AS builderImage withgcc and the base tools:
FROM aminya/setup-cpp-arch-gcc:base-1.2.2 AS builderImage withmingw and the base tools:
FROM aminya/setup-cpp-arch-mingw:base-1.2.2 AS builderIf you need to install the tools selectively, you can create your own Docker image with the tools you need.
Here is an example for using setup-cpp to make a builder image that has the Cpp tools you need.
#### Base ImageFROM ubuntu:22.04 as setup-cpp-ubuntuRUN apt-get update -qq && \# install nodejs apt-get install -y --no-install-recommends nodejs npm && \# install setup-cpp npm install -g setup-cpp@v1.1.1 && \# install the compiler and tools NODE_OPTIONS="--enable-source-maps" \ setup-cpp \ --nala true \ --compiler llvm \ --cmake true \ --ninja true \ --task true \ --vcpkg true \ --python true \ --make true \ --cppcheck true \ --gcovr true \ --doxygen true \ --ccache true && \# cleanup nala autoremove -y && \ nala autopurge -y && \ apt-get clean && \ nala clean --lists && \ rm -rf /var/lib/apt/lists/* && \ rm -rf /tmp/*SHELL ["/bin/bash","-l","-c"]ENTRYPOINT ["/bin/bash","-l"]#### Building (example)FROM setup-cpp-ubuntu AS builderCOPY ./dev/cpp_vcpkg_project /home/appWORKDIR /home/appRUN task build#### Running environment# use a fresh image as the runnerFROM ubuntu:22.04 as runner# copy the built binaries and their runtime dependenciesCOPY --from=builder /home/app/build/my_exe/Release/ /home/app/WORKDIR /home/app/ENTRYPOINT ["./my_exe"]
Seethis folder, for some dockerfile examples.
If you want to build the ones included, then run:
git clone --recurse-submodules https://github.com/aminya/setup-cppcd ./setup-cppdocker build -f ./dev/docker/setup-cpp/setup-cpp-ubuntu.dockerfile -t setup-cpp-ubuntu-llvm:22.04-17 ./Where you should use the path to the dockerfile after-f.
After build, run the following to start an interactive shell in your container
docker run -it setup-cpp-ubuntu-llvm:22.04-17
You can use the docker file discussed in the previous section inside GitHub Actions like the following:
jobs:Docker:runs-on:${{ matrix.os }}strategy:matrix:os: -ubuntu-24.04steps: -uses:actions/checkout@v3 -name:Buildid:docker_buildrun:| docker build -f ./dev/docker/ubuntu.dockerfile -t setup-cpp .
The following gives an example for setting up a C++ environment inside GitLab pipelines.
.gitlab-ci.yaml
image:ubuntu:22.04stages: -test.setup_linux:&setup_linux |DEBIAN_FRONTEND=noninteractive# set time-zoneTZ=Canada/Pacificln -snf /usr/share/zoneinfo/$TZ /etc/localtime && echo $TZ > /etc/timezone# for downloadingapt-get update -qqapt-get install -y --no-install-recommends curl gnupg ca-certificates.setup-cpp:&setup-cpp |# install nodejsapt-get install -y --no-install-recommends nodejs npm# install setup-cppnpm install -g setup-cpp@v1.1.1# install the compiler and tools./setup-cpp-x64-linux --compiler $compiler --cmake true --ninja true --ccache true --vcpkg truesource ~/.cpprc.test:&test |# Build and Test# ...test_linux_llvm:stage:testvariables:compiler:llvmscript:- *setup_linux- *setup-cpp- *testtest_linux_gcc:stage:testvariables:compiler:gccscript:- *setup_linux- *setup-cpp- *test
- cpp_vcpkg_project project
- project_options
- cpp-best-practices starter project
- ftxui
- inja
- teslamotors/fixed-containers
- zeromq.js
- json2cpp
- lefticus/tools
- watcher
- pinpoint-c-agent
- dpp
- DSpellCheck
- simdjson-rust
- CXXIter
- git-tui
- supercell
- libclang
- d-tree-sitter
- atom-community/papm
- ecs_benchmark
- smk
See all of the usage examples on GitHubhere.
About
Install all the tools required for building and testing C++ and C projects.
