Install all the tools required for building and testing C++/C projects.
Go to file Use this template
Amin Yahyaabadi b61c16aa45 Revert "fix: fix cross-spawn exit codes"
This reverts commit 1a81d4edde.
2021-09-17 15:19:32 -05:00
.github feat: add self-contained executables 2021-09-15 02:24:30 -05:00
building chore: add script for disabling debug messages in the release 2021-09-17 14:35:53 -05:00
dist fix: add colors to cli 2021-09-17 15:00:26 -05:00
src Revert "fix: fix cross-spawn exit codes" 2021-09-17 15:19:32 -05:00
.eslintrc.json feat: add msvc installation 2021-09-15 05:25:02 -05:00
.gitattributes chore: add the template 2021-09-14 01:50:42 -05:00
.gitignore fix: rename the executable 2021-09-17 13:19:10 -05:00
.gitmodules chore: use upstream msvc-dev-cmd 2021-09-16 03:54:36 -05:00
.npmrc chore: enable post install cache for pnpm 2021-09-15 04:09:26 -05:00
.prettierignore feat: add msvc installation 2021-09-15 05:25:02 -05:00
.terserrc.js chore: add script for disabling debug messages in the release 2021-09-17 14:35:53 -05:00
LICENSE.dependencies.txt feat: add python installation 2021-09-14 15:35:52 -05:00
LICENSE.txt chore: add the template 2021-09-14 01:50:42 -05:00
README.md chore: add readme about running the tool locally 2021-09-17 13:24:17 -05:00
action.yml feat: support gcc/mingw 2021-09-16 09:03:54 -05:00
jest.config.js test: exclude setup-python from the tests 2021-09-14 15:41:32 -05:00
package.json fix: untildify the installation path 2021-09-17 13:54:30 -05:00
pnpm-lock.yaml fix: untildify the installation path 2021-09-17 13:54:30 -05:00
pnpm-workspace.yaml chore: add the template 2021-09-14 01:50:42 -05:00
tsconfig.json feat: add msvc installation 2021-09-15 05:25:02 -05:00

README.md

setup-cpp

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

Build Status (Github Actions) Dependency Status

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)