Github-CI:

OS	Bazel	CMake
Linux
MacOS
Windows
Docker

Introduction

| Requirement | Codemap | Dependencies | Build | Bazel CI | CMake CI | Appendices | License |

Bazel C++ and pybind11 sample with tests and GitHub CI support.
This project should run on GNU/Linux, MacOS and Windows.

note: A CMake support is also provided as comparison

Requirement

You'll need:

• "Bazel >= 6.0".
• "CMake >= 3.25".

Codemap

The project layout is as follow:

• WORKSPACE Top-level for Bazel based build.
• CMakeLists.txt Top-level for CMake based build.
• pure_lib Pure python library to check Bazel Python support.
• bp11 Python package name.
  • foo Simple C++ library.
    • python Python wrapper using Pybind11.

note: Due to a limitation of bazel and protoc directory layout must follow the python module hierarchy (ed in CMake we create our python layout in the ${PROJECT_BINARY_DIR}/python so we don't have any constraint on the source layout). ref: protocolbuffers/protobuf#7061

Build

To build this example you should use:

• on UNIX:

  bazel build -c opt --action_env=BAZEL_CXXOPTS="-std=c++17" --subcommands=true ...

• on Windows when using MSVC:

  bazel build -c opt --cxxopt="/std:c++17" --subcommands=true ...

Running Tests

To build this example you should use:

• on UNIX:

  bazel test -c opt --action_env=BAZEL_CXXOPTS="-std=c++17" --test_output=errors --nocache_test_results ...

• on Windows when using MSVC:

  bazel test -c opt --cxxopt="/std:c++17" --test_output=errors --nocache_test_results ...

CI Setup

Please take a look at .github/workflows to find the configuration file for each jobs.

To install bazel on each hosted runner, follow these links: ref: https://docs.github.com/en/actions/using-github-hosted-runners/customizing-github-hosted-runners#installing-software-on-windows-runners

• Linux (Ubuntu latest LTS) -> apt-get install bazel
  ref: https://docs.bazel.build/versions/main/install-ubuntu.html
  (as of 06/2021 Ubuntu 20.04 LTS is still not supported according to the doc...)
• MacOS -> brew install bazel
  ref: https://formulae.brew.sh/formula/bazel#default
• Windows -> choco install bazel
  ref: https://community.chocolatey.org/packages/bazel/

Appendices

Few links on the subject...

Resources

Project layout:

• The Pitchfork Layout Revision 1 (cxx-pflR1)

Bazel:

• https://docs.bazel.build/versions

Misc

Image has been generated using plantuml:

plantuml -Tsvg docs/{file}.dot

So you can find the dot source files in docs.

License

Apache 2. See the LICENSE file for details.

Disclaimer

This is not an official Google product, it is just code that happens to be owned by Google.