Linux GCC CI (#60)

Basic Linux GCC CI 
Minor updates to README
Minor updates to AfterInstall example
Minor updates to CustomTarget hybrid example

Author: coder137

.github/workflows/linux_gcc_cmake_build.yml

@@ -0,0 +1,93 @@
+name: Linux GCC CMake build
+
+on:
+  push:
+    branches: [main]
+  pull_request:
+    branches: [main]
+
+env:
+  # Customize the CMake build type here (Release, Debug, RelWithDebInfo, etc.)
+  BUILD_TYPE: Release
+  BUILD_FOLDER: _build_gcc_dev_all
+
+jobs:
+  build:
+    # The CMake configure and build commands are platform agnostic and should work equally
+    # well on Windows or Mac.  You can convert this to a matrix build if you need
+    # cross-platform coverage.
+    # See: https://docs.github.com/en/free-pro-team@latest/actions/learn-github-actions/managing-complex-workflows#using-a-build-matrix
+    runs-on: ubuntu-latest
+
+    steps:
+      - uses: actions/checkout@v2
+        with:
+          submodules: true
+
+      - name: System Packages
+        run: |
+          sudo apt-get install ninja-build doxygen graphviz gcovr lcov cppcheck clang-tidy
+
+      - name: Check environment
+        run: |
+          cmake --version
+          gcc --version
+          clang --version
+          ninja --version
+          doxygen --version
+          gcovr --version
+          lcov --version
+          cppcheck --version
+          clang-tidy --version
+
+      - name: Configure CMake
+        run: |
+          cmake --list-presets
+          cmake --preset=gcc_dev_all
+
+      - name: Static Analysis
+        working-directory: ${{github.workspace}}/${{env.BUILD_FOLDER}}
+        run: cmake --build . --target cppcheck_static_analysis
+
+      - name: Build
+        # Linux has 2 cores
+        run: |
+          cmake --build --list-presets
+          cmake --build --preset=gcc_dev_all --parallel 2
+
+      - name: Test
+        run: |
+          ctest --preset=gcc_dev_all --parallel 2
+
+      - name: Install
+        working-directory: ${{github.workspace}}/${{env.BUILD_FOLDER}}
+        run: |
+          sudo cmake --install .
+
+      - name: Hybrid Simple Example
+        working-directory: ${{github.workspace}}/${{env.BUILD_FOLDER}}
+        run: |
+          cmake --build . --target run_hybrid_simple_example_linux
+
+      - name: Hybrid Foolib Example
+        working-directory: ${{github.workspace}}/${{env.BUILD_FOLDER}}
+        run: |
+          cmake --build . --target run_hybrid_foolib_example_linux
+
+      - name: Hybrid External Lib Example
+        working-directory: ${{github.workspace}}/${{env.BUILD_FOLDER}}
+        run: |
+          cmake --build . --target run_hybrid_externallib_example_linux
+
+      - name: Hybrid Custom Target Example
+        working-directory: ${{github.workspace}}/${{env.BUILD_FOLDER}}
+        run: |
+          cmake --build . --target run_hybrid_customtarget_example_linux
+
+      - name: AfterInstall Example
+        working-directory: ${{github.workspace}}/example/gcc/AfterInstall
+        run: |
+          cmake -B build -G Ninja
+          cmake --build build --parallel 2
+          cd build
+          ./build

README.md

@@ -6,6 +6,18 @@ Build C, C++ and ASM files in C++
 
 **_BuildCC_** aims to be an alternative to **Makefiles** while using the feature rich C++ language. 
 
+## Pre-requisites
+
+- C++17 Compiler with
+  - `C++17 filesystem` library support
+  - `C++11 thread` library support
+- Third Party Libraries (See License below)
+  - Flatbuffers
+  - Taskflow
+  - CLI11
+  - fmt
+  - spdlog
+
 # General Information
 
 - A `compile` + `link` procedure is called a **Target**
@@ -29,7 +41,7 @@ See also [Software Architecture](#software-architecture)
 
 ## Features
 
-- Complete flexibility for custom / brand new toolchains
+- Complete flexibility for custom workflows and toolchains
 - C++ language feature benefits and **debuggable build binaries**
 - Optimized rebuilds through serialization. See [target.fbs schema](buildcc/lib/target/fbs/target.fbs)
   - Can optimize for rebuilds by comparing the previous stored build with current build.

buildcc/lib/target/cmake/mock_target.cmake

@@ -5,7 +5,7 @@ target_include_directories(mock_target PUBLIC
     ${CMAKE_CURRENT_BINARY_DIR}/generated
 )
 
-target_sources(mock_target PUBLIC
+target_sources(mock_target PRIVATE
     ${CMAKE_CURRENT_SOURCE_DIR}/src/target/target.cpp
     ${CMAKE_CURRENT_SOURCE_DIR}/src/target/source.cpp
     ${CMAKE_CURRENT_SOURCE_DIR}/src/target/include_dir.cpp

example/gcc/AfterInstall/CMakeLists.txt

@@ -10,31 +10,35 @@ project(simple)
 
 # Package dependencies
 # fmt is imported by spdlog by default
+find_package(fmt_package NAMES "fmt" REQUIRED)
 find_package(spdlog_package NAMES "spdlog" REQUIRED)
-find_package(flatbuffers_package NAMES "flatbuffers" REQUIRED)
+find_package(flatbuffers_package NAMES "Flatbuffers" "flatbuffers" REQUIRED)
+find_package(taskflow_package NAMES "Taskflow" "taskflow" REQUIRED)
+find_package(CLI11_package NAMES "CLI11" REQUIRED)
+
 find_package(env_package NAMES "env" REQUIRED)
 find_package(toolchain_package NAMES "toolchain" REQUIRED)
 find_package(toolchain_specialized_package NAMES "toolchain_specialized" REQUIRED)
-find_package(taskflow_package NAMES "taskflow" REQUIRED)
 find_package(target_package NAMES "target" REQUIRED)
 find_package(target_gcc_package NAMES "target_gcc" REQUIRED)
 find_package(target_msvc_package NAMES "target_msvc" REQUIRED)
 find_package(plugins NAMES "plugins" REQUIRED)
 
-find_package(CLI11_package NAMES "CLI11" REQUIRED)
 find_package(buildcc_package NAMES "buildcc" REQUIRED)
 
+message("Find package: ${fmt_package_DIR}")
 message("Find package: ${spdlog_package_DIR}")
 message("Find package: ${flatbuffers_package_DIR}")
+message("Find package: ${taskflow_package_DIR}")
+message("Find package: ${CLI11_package_DIR}")
+
 message("Find package: ${env_package_DIR}")
 message("Find package: ${toolchain_specialized_package_DIR}")
 message("Find package: ${toolchain_package_DIR}")
-message("Find package: ${taskflow_package_DIR}")
 message("Find package: ${target_package_DIR}")
 message("Find package: ${target_gcc_package_DIR}")
 message("Find package: ${target_msvc_package_DIR}")
 message("Find package: ${plugins_DIR}")
-message("Find package: ${CLI11_package_DIR}")
 message("Find package: ${buildcc_package_DIR}")
 
 # build executable

example/hybrid/custom_target/build.main.cpp

@@ -63,9 +63,8 @@ class ExecutableTarget_clang : public base::Target {
 int main(int argc, char **argv) {
   // 1. Get arguments
   Args args;
-  Args::Toolchain clang_w64_windows_gnu;
-  args.AddCustomToolchain("clang_w64_windows_gnu", "MSYS MINGW clang compiler",
-                          clang_w64_windows_gnu);
+  Args::Toolchain clang_gnu;
+  args.AddCustomToolchain("clang_gnu", "Clang GNU compiler", clang_gnu);
   args.Parse(argc, argv);
 
   // 2. Initialize your environment
@@ -86,11 +85,11 @@ int main(int argc, char **argv) {
   reg.Build(args.GetMsvcToolchain(), m_foolib, mfoolib_build_cb);
 
   // * NOTE, This is how we add our custom toolchain
-  base::Toolchain clang("clang_w64_windows_gnu", "llvm-as", "clang", "clang++",
-                        "llvm-ar", "ld");
+  base::Toolchain clang("clang_gnu", "llvm-as", "clang", "clang++", "llvm-ar",
+                        "ld");
   // * NOTE, Custom clang target added above
   ExecutableTarget_clang c_foolib("CFoolib.exe", clang, "");
-  reg.Build(clang_w64_windows_gnu, c_foolib, cfoolib_build_cb);
+  reg.Build(clang_gnu, c_foolib, cfoolib_build_cb);
 
   // 5.
   reg.RunBuild();

example/hybrid/custom_target/build_linux.toml

@@ -16,6 +16,6 @@ build = false
 test = false
 
 # Custom toolchain added here
-[toolchain.clang_w64_windows_gnu]
+[toolchain.clang_gnu]
 build = true
 test = true

example/hybrid/custom_target/build_win.toml

@@ -16,6 +16,6 @@ build = true
 test = true
 
 # Custom toolchain added here
-[toolchain.clang_w64_windows_gnu]
+[toolchain.clang_gnu]
 build = true
 test = true