Mini.Project 01-03. Deploy: Integrated CMake, Docker and CI/CD

Mini.Project 01-03. Deploy: Integrated CMake, Docker and CI/CD

---

Prerequisites

    C++

---

1. CMake

C++ Project + CMake

/Project:
  - "CMakeLists.txt"            # CMake
  - "/cmake:"
        - "CMakeGenLib.cmake"   # CMake
  - main.cpp
  - /tests:
    - test_svstring.cpp
  - /lib:
    - "CMakeLists.txt"          # CMake
    - /structlib:
      - "CMakeLists.txt"        # CMake
      - /src:
        - SVBase.cpp
        - SVString.cpp
      - /include:
        - SVBase.h
        - SVString.h

• Each folder in the hierarchy contains a CMakeLists.txt (just one)
• CMakeLists.txt acts like a “recipe” for building the project

2. CMakeLists.txt

Each folder in the hierarchy contains a CMakeLists.txt. CMakeLists.txt acts like a “recipe” for building the project. So CMake acts following the CMakeLists script.

The order is like this:

Following to CMakeLists, the source files are integrated and build. By means that is we should understand the flow of CMakeLists script.

Let’s see the CMakeLists of project

2-1. /Project/CMakeLists.txt

cmake_minimum_required(VERSION 3.10)
project(deploy-project)

include(CTest)
enable_testing()

include(cmake/CMakeGenLib.cmake)

add_executable(${PROJECT_NAME} main.cpp)
target_link_libraries(${PROJECT_NAME} PRIVATE structlib)

install(TARGETS ${PROJECT_NAME} 
	RUNTIME DESTINATION bin
)

install(TARGETS structlib 
	RUNTIME DESTINATION bin 
	LIBRARY DESTINATION lib
	ARCHIVE DESTINATION lib
)

add_executable(test_svstring tests/test_svstring.cpp)
target_link_libraries(test_svstring PRIVATE structlib)

add_test(NAME SVStringTest COMMAND test_svstring)

2-2. /Project/cmake/CMakeGenLib.cmake

add_subdirectory(lib)

cmake version and project names

cmake_minimum_required(VERSION 3.10)
project(deploy-project)

include optional test environment

include(CTest)
enable_testing()

include

include(cmake/CMakeGenLib.cmake)

The include script will be copy and paste from “cmake/CMakeGenLib.cmake” to “ CMakeLists.txt”. This meaning is there will be like that:

include(cmake/CMakeGenLib.cmake) -> add_subdirectory(lib)

explore subdirectory

add_subdirectory(lib)

add_subdirectory(lib) script explores subdirectory “/lib”

create executable file

add_executable(${PROJECT_NAME} main.cpp)

It depends on OS, on Window, extension .exe will be created. The ${PROJECT_NAME} is same XXXX of project(XXXX) script. In this case, ${PROJECT_NAME} is “deploy-project”

link libraries

target_link_libraries(${PROJECT_NAME} PRIVATE structlib)

This script is link process on compile step “link”. At the first time, I’m little bit surprised because there’s no complie trigger. But we do not need to think compile timing.

The “structlib.lib” is linked with “project-deploy”

Keyword	Used in Target	Propagated to Dependents	Include Directories	Compile Options
PRIVATE	Yes	No	No	No
PUBLIC	Yes	Yes	Yes	Yes
INTERFACE	No	Yes	Yes	Yes

install

install(TARGETS ${PROJECT_NAME} 
	RUNTIME DESTINATION bin
)

install(TARGETS structlib 
	RUNTIME DESTINATION bin 
	LIBRARY DESTINATION lib
	ARCHIVE DESTINATION lib
)

The install step is following on this script. Actually the install step is not creating anythings. It will rearrange build files with Copy and Paste.

Type	Role
RUNTIME	Executable files
LIBRARY	Share library
ARCHIVE	Static library

test

add_executable(test_svstring tests/test_svstring.cpp)
target_link_libraries(test_svstring PRIVATE structlib)

add_test(NAME SVStringTest COMMAND test_svstring)

“add_executable” and “target_link_libraries” is already explained. “add_test” regists the test_svstring execuatble file as test and name will be SVStringTest. on ctest, the name is SVStringTest.

2-3. /Project/lib/CMakeLists.txt

add_subdirectory(structlib)

2-4. /Project/lib/structlib/CMakeLists.txt

file(GLOB SRC_FILES "src/*.cpp")

add_library(structlib STATIC ${SRC_FILES})
target_include_directories(structlib PUBLIC ${CMAKE_CURRENT_SOURCE_DIR}/include)

collect to source files on var

file(GLOB SRC_FILES "src/*.cpp")

“file” is function related in file command “GLOB SRC_FILES “src/*.cpp”” command searches matching on source files within src directory. The files will be included in SRC_FILES var.

make library

add_library(structlib STATIC ${SRC_FILES})

Using SRC_FILES files, creating a library. name is structlib library

Type	Link Time	Runtime Requirement	Output Files
STATIC	Compile time	None	.lib / .a
SHARED	Runtime	Required	.dll / .so
MODULE	Runtime (manual)	Required	.dll / .so

include directory

target_include_directories(structlib PUBLIC ${CMAKE_CURRENT_SOURCE_DIR}/include)

Include the .h to structlib library.

Scope	Used by structlib	Used by dependents
PRIVATE	Yes	No
PUBLIC	Yes	Yes
INTERFACE	No	Yes

3. CMake command

Configuration → Build → Install

The commands can differ depending on the OS you are using.

3-1. Configuration

cmake -S . -B build 

Configuration → Generate build system (no compilation)

This step configures the project by reading the CMakeLists.txt file and generating the build system (e.g., Visual Studio solution, Makefiles, or Ninja files) inside the build directory.

• -S . specifies the source directory (current directory)
• -B build specifies the output directory for build files

👉 No compilation happens at this stage. It only prepares the build environment.

OR

make -S . -B build -G "Visual Studio 17 2022" -A x64

3-2. Build

cmake --build build --config Release

Build → Compile and link targets

This step compiles the source code and links the targets defined in the project.

• –build build tells CMake to build using the generated build system
• –config Release specifies the build configuration (required for multi-config generators like Visual Studio)

👉 This is where actual compilation and linking occur, producing executables and libraries.

OR Linux OS

cmake --build build --config Release

3-3. Install

cmake --install build --config Release --prefix install

Install → Copy artifacts to distribution structure

This step installs the built artifacts (executables, libraries, etc.) into a structured directory for distribution.

• –install build runs the install rules defined in CMakeLists.txt
• –config Release ensures the correct build configuration is used
• –prefix install sets the installation directory (e.g., ./install)

👉 Files are copied into organized folders such as bin/, lib/, etc., based on the install() rules.

3-4. Test

ctest --test-dir build -C Release --output-on-failure

This step runs the tests registered in the project using CTest.

• –test-dir build specifies the directory where the build was generated
• -C Release selects the build configuration (required for multi-config generators like Visual Studio)
• –output-on-failure prints detailed output only when a test fails

👉 CTest executes the test commands defined by add_test() in CMakeLists.txt.