setup-cpp/README.md

189 lines
5.6 KiB
Markdown
Raw Normal View History

2021-09-14 14:51:57 +08:00
# setup-cpp
2021-09-14 14:57:47 +08:00
Install all the tools required for building and testing C++/C projects.
2021-09-14 14:51:57 +08:00
![Build Status (Github Actions)](https://github.com/aminya/setup-cpp/workflows/CI/badge.svg)
2021-09-14 15:00:41 +08:00
[![Dependency Status](https://david-dm.org/aminya/setup-cpp.svg)](https://david-dm.org/aminya/setup-cpp)
2021-09-14 17:40:04 +08:00
2021-09-17 19:29:58 +08:00
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.
2021-09-14 17:40:04 +08:00
2021-09-17 19:29:58 +08:00
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.
2021-09-14 17:40:04 +08:00
2021-09-17 19:29:58 +08:00
The package can be used locally or from CI services like GitHub Actions. Stay tuned for the stable release.
2021-09-14 17:40:04 +08:00
2021-09-17 19:29:58 +08:00
# Features
2021-09-16 20:15:17 +08:00
2021-09-17 19:29:58 +08:00
`setup-cpp` can install all of these tools:
2021-09-16 18:00:16 +08:00
2021-09-17 19:29:58 +08:00
- llvm
2021-09-17 23:47:30 +08:00
- gcc
2021-09-17 19:29:58 +08:00
- cmake
- ninja
2021-11-22 00:49:22 +08:00
- vcpkg
2021-09-17 19:29:58 +08:00
- meson
- conan
- ccache
- cppcheck
- doxygen
- gcovr
- opencppcoverage
- python
- choco
- brew
2021-09-16 18:00:16 +08:00
# Usage
# From Terminal
2021-11-22 04:20:51 +08:00
You should download the executable file or the js file (if Nodejs installed), and run it with the available options.
2021-11-22 04:20:51 +08:00
Tip: You can automate downloading using `wget`, `curl`, or other similar tools.
### Executable
2021-11-22 07:07:02 +08:00
Download the executable for your platform from [here](https://github.com/aminya/setup-cpp/releases/tag/v0.3.1), and run it with the available options.
2021-11-22 02:11:26 +08:00
An example that installs llvm, cmake, ninja, ccache, and vcpkg:
```ps1
# windows example (open shell as admin)
2021-11-29 18:55:00 +08:00
curl -LJO "https://github.com/aminya/setup-cpp/releases/download/v0.3.1/setup_cpp_windows.exe"
2021-11-22 02:11:26 +08:00
./setup_cpp_windows --compiler llvm --cmake true --ninja true --ccache true --vcpkg true
```
```ps1
# linux example
2021-11-22 07:07:02 +08:00
wget "https://github.com/aminya/setup-cpp/releases/download/v0.3.1/setup_cpp_linux"
chmod +x setup_cpp_linux
2021-11-22 02:11:26 +08:00
sudo ./setup_cpp_linux --compiler llvm --cmake true --ninja true --ccache true --vcpkg true
```
```ps1
# mac example
2021-11-22 07:07:02 +08:00
wget "https://github.com/aminya/setup-cpp/releases/download/v0.3.1/setup_cpp_mac"
chmod +x setup_cpp_mac
2021-11-22 02:11:26 +08:00
sudo ./setup_cpp_mac --compiler llvm --cmake true --ninja true --ccache true --vcpkg true
```
2021-09-19 01:05:52 +08:00
NOTE: In the `compiler` entry, you can specify the version after `-` like `llvm-11`.
2021-11-22 04:20:51 +08:00
For the tools, instead of `true` that chooses the default version, you can pass a specific version.
2021-09-19 01:05:52 +08:00
### With Nodejs
2021-11-22 07:07:02 +08:00
Download the `setup_cpp.js` file form [here](https://github.com/aminya/setup-cpp/releases/download/v0.3.1/setup_cpp.js), and run it with the available options.
On Windows
```ps1
# open shell as admin
2021-11-22 07:07:02 +08:00
curl "https://github.com/aminya/setup-cpp/releases/download/v0.3.1/setup_cpp.js"
2021-11-22 02:11:26 +08:00
node ./setup_cpp.js --compiler llvm --cmake true --ninja true --ccache true --vcpkg true
```
On Linux or Mac:
```ps1
2021-11-22 07:07:02 +08:00
wget "https://github.com/aminya/setup-cpp/releases/download/v0.3.1/setup_cpp.js"
2021-11-22 02:11:26 +08:00
sudo node ./setup_cpp.js --compiler llvm --cmake true --ninja true --ccache true --vcpkg true
```
# Inside GitHub Actions
2021-11-22 02:11:26 +08:00
Here is a complete cross-platform example that tests llvm and gcc. It also uses cmake, ninja, vcpkg, cppcheck, and ccache.
`.github/workflows/ci.yml`:
```yaml
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
2021-09-18 04:32:14 +08:00
uses: aminya/setup-cpp@v1
with:
compiler: ${{ matrix.compiler }}
cmake: true
ninja: true
2021-11-22 07:07:02 +08:00
vcpkg: true
cppcheck: true # instead of `true`, which chooses the default version, you can pass a specific version.
2021-09-17 23:47:30 +08:00
# add any tool that you need here...
```
# Inside Docker
2021-11-22 04:20:51 +08:00
Here is an example for using setup_cpp to make a builder image that has the Cpp tools you need.
```dockerfile
2021-09-19 01:05:52 +08:00
# debian
FROM debian:bullseye
2021-09-19 01:05:52 +08:00
# add setup_cpp
WORKDIR "/"
RUN apt-get update -qq
RUN apt-get install -y --no-install-recommends apt-utils
2021-09-19 01:45:10 +08:00
RUN apt-get install -y --no-install-recommends ca-certificates wget unzip
2021-11-22 07:07:02 +08:00
RUN wget --no-verbose "https://github.com/aminya/setup-cpp/releases/download/v0.3.1/setup_cpp_linux"
2021-09-19 01:05:52 +08:00
RUN chmod +x ./setup_cpp_linux
2021-11-22 02:11:26 +08:00
# install llvm, cmake, ninja, ccache, and vcpkg
RUN ./setup_cpp_linux --compiler llvm --cmake true --ninja true --ccache true --vcpkg true
ENTRYPOINT [ "/bin/sh" ]
```
See [this folder](https://github.com/aminya/setup-cpp/tree/master/building/docker), for some dockerfile examples.
2021-09-19 01:05:52 +08:00
If you want to build the ones included, then run:
```ps1
2021-09-19 01:05:52 +08:00
docker build -f ./building/docker/debian.dockerfile -t setup_cpp .
```
2021-11-22 04:20:51 +08:00
Where you should use the path to the docker after `-f`.
After build, run the following to start an interactive shell in your container
```ps1
docker run -it setup_cpp
```
2021-09-19 01:05:52 +08:00
2021-09-17 19:29:58 +08:00
### Incomplete
2021-09-16 18:00:16 +08:00
2021-11-22 04:20:51 +08:00
- `msvc`. It is implemented, but it has bugs. See [this issue](https://github.com/aminya/setup-cpp/issues/1)