2.6 KiB

Raw Blame History

setup-cpp

Install all the tools required for building and testing C++/C projects.

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. This package aims to fix this issue.

This package 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 or from CI services like GitHub Actions. Stay tuned for the stable release.

Features

setup-cpp can install all of these tools:

llvm
gcc
cmake
ninja
meson
conan
ccache
cppcheck
doxygen
gcovr
opencppcoverage
python
choco
brew

Usage

From Command Prompt

You should download the exe file or the js file (if have Nodejs installed) and then run it.

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

Executable

./setup_cpp.exe --compiler llvm --cmake true --ninja true --ccache true --conan "1.40.1"

With Nodejs

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

node ./setup_cpp.js --compiler llvm --cmake true --ninja true --ccache true --conan "1.40.1"

Inside GitHub Actions

Here is a complete cross-platform example that tests llvm and gcc. It also uses cmake, ninja, conan, cppcheck, and ccache.

.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
    steps:
      - name: Setup Cpp
        uses: aminya/setup-cpp@master
        with:
          compiler: ${{ matrix.compiler }}
          cmake: true
          ninja: true
          conan: true
          cppcheck: true
          ccache: true
          # add any tool that you need here...

In the compiler entry, you can specify the version after a -. For example, llvm-11.

For the tools, instead of true, which chooses the default version, you can pass a specific version.

Incomplete

msvc. It is implemented, but has bugs. See this issue
vcpkg (TODO)

2.6 KiB Raw Blame History