CPP17

CPP17 is intended to serve as a base skeleton/framework for C++17 projects with the following features:

1. Configures via CMake
2. Integrates with GitHub Workflows for CI, which uses Ubuntu 18.04 and installs following to build:
   1. cmake (3.15+)
   2. g++-8
   3. ninja (1.8+)
   4. (Optional) clang-8, lld-8

Usage

Build Sample

Clone the repository

git clone https://github.com/karnkaul/CPP17

Use CMake to generate a build directory in out/... using Source

Command line:

CONFIG=Debug	# Or Release / RelWithDebInfo / etc
cmake -G Ninja . -Bout/$CONFIG -DCMAKE_BUILD_TYPE=$CONFIG

GUI:

1. Select repo root as Source directory
2. Select out/... as the Build directory (config subdirectory not required for IDE project generators)
3. Click Configure
4. For single-configuration generators: enter the desired value for CMAKE_BUILD_TYPE
5. Click Generate

Build the project:

If using IDE project generators, open the generated project/solution/workspace in the corresponding IDE and build BUILD_ALL.

Command line:

cmake --build out/$CONFIG

Use as Base Setup

1. Fork the repository in into your own account
2. Follow Build Sample to ensure project works
3. Replace with your source code and CMake files

GitHub

All GitHub related files are in .github:

1. workflows/ci.yml sets up the overall workflow; edit the on: sections to adjust automated build triggers
2. CI/pre-build.sh sets up the build environment; optionally pass "TRUE" to also install clang and llvm
3. CI/build-config.sh builds the config passed as the first argument (Release if empty); pass "TRUE" as the second argument to use /usr/bin/clang++

GitHub Branch Protections

In repository settings, select "Branches" and set up protections for branch wildcards to enable:

1. Prevention of branch deletions / force pushes
2. Require status checks to pass
   1. After a CI Action has run, it will appear as an option here (to be selected as "Required")