DEV Community

Amin Yahyaabadi
Amin Yahyaabadi

Posted on • Updated on

Setup-Cpp

Setting up a cross-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. setup-cpp aims to fix this issue.

https://github.com/aminya/setup-cpp

My Workflow

setup-cpp is designed to be modular and as minimal as possible. This will allow you to install the tools you want. It is continuously tested on Windows, Linux, and macOS.

The package can be used locally, from CI services like GitHub Actions, or inside containers like Docker.

Refer to the repository for examples for each environment.

setup-cpp can install all of these tools:

  • cmake
  • ninja
  • llvm
  • gcc
  • msvc
  • vcvarsall
  • vcpkg
  • meson
  • conan
  • ccache
  • cppcheck
  • doxygen
  • gcovr
  • opencppcoverage
  • kcov
  • python
  • choco
  • brew

Submission Category: Maintainer Must-Haves

Inside GitHub Actions

Here is a complete cross-platform example inside GitHub Actions that tests llvm, gcc, and msvc. It also uses cmake, ninja, vcpkg, and cppcheck.

.github/workflows/ci.yml:

name: ci
on:
  pull_request:
  push:
    branches:
      - main
      - master

jobs:
  Test:
    runs-on: ${{ matrix.os }}
    strategy:
      fail-fast: false
      matrix:
        os:
          - windows-2019
          - ubuntu-20.04
          - macos-10.15
        compiler:
          - llvm
          - gcc
          # you can specify the version after `-` like `llvm-13.0.0`.
        include:
          - os: "windows-latest"
            compiler: "msvc"
    steps:
      - name: Cache
        uses: actions/cache@v2
        with:
          path: |
            ~/vcpkg
            ./build/vcpkg_installed
            ${{ env.HOME }}/.cache/vcpkg/archives
            ${{ env.XDG_CACHE_HOME }}/vcpkg/archives
            ${{ env.LOCALAPPDATA }}\vcpkg\archives
            ${{ env.APPDATA }}\vcpkg\archives
          key: ${{ runner.os }}-${{ matrix.compiler }}-${{ env.BUILD_TYPE }}-${{ hashFiles('**/CMakeLists.txt') }}-${{ hashFiles('./vcpkg.json')}}
          restore-keys: |
            ${{ runner.os }}-${{ env.BUILD_TYPE }}

      - name: Setup Cpp
        uses: aminya/setup-cpp@v1
        with:
          compiler: ${{ matrix.compiler }}
          cmake: true
          ninja: true
          vcpkg: true
          cppcheck: true # instead of `true`, which chooses the default version, you can pass a specific version.
          # add any tool that you need here...
Enter fullscreen mode Exit fullscreen mode

From Terminal

As we discussed before, setup-cpp is also usable from Terminal! This means that you can use it to setup the Cpp tools on your local machine or any other CI services.

To do so, you should download the executable file or the js file (if Nodejs installed), and run it with the available options.

Tip: You can automate downloading using wget, curl, or other similar tools.

Executable

Download the executable for your platform from here, and run it with the available options.

An example that installs llvm, cmake, ninja, ccache, and vcpkg:

# windows example (open shell as admin)
curl -LJO "https://github.com/aminya/setup-cpp/releases/download/v0.5.2/setup_cpp_windows.exe"
./setup_cpp_windows --compiler llvm --cmake true --ninja true --ccache true --vcpkg true
Enter fullscreen mode Exit fullscreen mode
# linux example
wget "https://github.com/aminya/setup-cpp/releases/download/v0.5.2/setup_cpp_linux"
chmod +x setup_cpp_linux
sudo ./setup_cpp_linux --compiler llvm --cmake true --ninja true --ccache true --vcpkg true
Enter fullscreen mode Exit fullscreen mode
# mac example
wget "https://github.com/aminya/setup-cpp/releases/download/v0.5.2/setup_cpp_mac"
chmod +x setup_cpp_mac
sudo ./setup_cpp_mac --compiler llvm --cmake true --ninja true --ccache true --vcpkg true
Enter fullscreen mode Exit fullscreen mode

NOTE: In the compiler entry, you can specify the version after - like llvm-11.
For the tools, instead of true that chooses the default version, you can pass a specific version.

With Nodejs

Download the setup_cpp.js file form here, and run it with the available options.

On Windows:

Open the shell as admin, download via curl, then install

# open shell as admin
curl -LJO "https://github.com/aminya/setup-cpp/releases/download/v0.5.2/setup_cpp.js"
node ./setup_cpp.js --compiler llvm --cmake true --ninja true --ccache true --vcpkg true
Enter fullscreen mode Exit fullscreen mode

On Linux or Mac:

wget "https://github.com/aminya/setup-cpp/releases/download/v0.5.2/setup_cpp.js"
sudo node ./setup_cpp.js --compiler llvm --cmake true --ninja true --ccache true --vcpkg true
Enter fullscreen mode Exit fullscreen mode

Inside Docker

Here is an example for using setup-cpp to make a builder image that has the Cpp tools you need.

# debian
FROM debian:bullseye

# add setup_cpp
WORKDIR "/"
RUN apt-get update -qq
RUN apt-get install -y --no-install-recommends apt-utils
RUN apt-get install -y --no-install-recommends ca-certificates wget unzip
RUN wget --no-verbose "https://github.com/aminya/setup-cpp/releases/download/v0.5.2/setup_cpp_linux"
RUN chmod +x ./setup_cpp_linux

# install llvm, cmake, ninja, and ccache
RUN ./setup_cpp_linux --compiler llvm --cmake true --ninja true --ccache true

ENTRYPOINT [ "/bin/sh" ]
Enter fullscreen mode Exit fullscreen mode

See this folder, for some dockerfile examples.

If you want to build the ones included, then run:

docker build -f ./building/docker/debian.dockerfile -t setup_cpp .
Enter fullscreen mode Exit fullscreen mode

Where you should use the path to the docker after -f.

After build, run the following to start an interactive shell in your container

docker run -it setup_cpp
Enter fullscreen mode Exit fullscreen mode

Inside Docker inside GitHub Actions

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-20.04
    steps:
      - uses: actions/checkout@v2
      - name: Build
        id: docker_build
        run: |
          docker build -f ./building/docker/debian.dockerfile -t setup_cpp .
        env:
          ACTIONS_ALLOW_UNSECURE_COMMANDS: true
Enter fullscreen mode Exit fullscreen mode

Additional Resources / Info

Usage examples:

See all of the usage examples on GitHub here.

Discussion (0)