Install all the tools required for building and testing C++/C projects.
Go to file Use this template
Amin Yahyaabadi 736836f507 chore: improve the types for setups and tools 2021-09-17 12:12:33 -05:00
.github feat: add self-contained executables 2021-09-15 02:24:30 -05:00
building build: remove .sh executables 2021-09-15 02:24:30 -05:00
dist build: add dist files 2021-09-17 06:35:55 -05:00
src chore: improve the types for setups and tools 2021-09-17 12:12:33 -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 build: add dist files 2021-09-17 06:35:55 -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: run format 2021-09-14 02:00:41 -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 docs: simplify the example [skip ci] 2021-09-17 10:48:09 -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 test: use cross-spawn in the tests 2021-09-17 05:28:57 -05:00
pnpm-lock.yaml test: use cross-spawn in the tests 2021-09-17 05:28:57 -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

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)