Template for Cpp Project

Usage

Docker Image

Run docker compose, it will build the image and run the container.

docker-compose up -d

Note: The container will be running in the background. And repository will be mounted to the container.

If you want to any dependencies, you can add them in the Dockerfile and rebuild the image.

docker build --no-cache .

Github Action

Change the repository_url with your own in the .chglog/config.yml file. Otherwise the link will be broken.

style: github
template: CHANGELOG.tpl.md
info:
  title: CHANGELOG
  repository_url: https://github.com/hncelestialtech/cpp_template

To use the CHANGELOG generator, your commit message should be in the following format.

feat: Add new feature
or
feat(scope): Add new feature

Refer to the Conventional Commits for more information.

CMake and Conan

This project uses CMake and Conan for building and managing dependencies. You can add the dependencies in the conanfile.txt file. You can refer to the Conan Center for the available packages.

To build the project, run the following commands.

make build

Also, you can run the tests using the following command.

make test

Note: The make command is a wrapper for the cmake and conan commands. Please remember to use find_package in the CMakeLists.txt file to include the dependencies. You can refer to the CMakeLists.txt file in the tests directory.

Contributing

Use linear issue: Optimize Build Workflow to track the progress.