Merge pull request #4 from saxbophone/josh/github-actions

Add Github action for testing

Author: saxbophone

.github/workflows/continuous-integration.yml

@@ -0,0 +1,77 @@
+name: continuous-integration
+
+on:
+  push:
+  release:
+    types: [published]
+
+jobs:
+  build:
+    runs-on: ${{ matrix.os }}
+    strategy:
+      fail-fast: false
+      matrix:
+        os: [macos-latest, ubuntu-20.04]
+        cxx: [g++-10, clang++]
+        include:
+          - os: windows-latest
+            cxx: msvc
+
+    steps:
+      - uses: actions/checkout@v2
+
+      - name: Configure CMake
+        env:
+          CXX: ${{ matrix.cxx }}
+        # Use a bash shell so we can use the same syntax for environment variable
+        # access regardless of the host operating system
+        shell: bash
+        working-directory: ${{github.workspace}}/build
+        # Note the current convention is to use the -S and -B options here to specify source 
+        # and build directories, but this is only available with CMake 3.13 and higher.  
+        # The CMake binaries on the Github Actions machines are (as of this writing) 3.12
+        run: cmake $GITHUB_WORKSPACE -DCMAKE_BUILD_TYPE=Debug -DCMAKE_INSTALL_PREFIX:PATH=$GITHUB_WORKSPACE/artifacts
+
+      - name: Build
+        working-directory: ${{github.workspace}}/build
+        shell: bash
+        # Execute the build.  You can specify a specific target with "--target <NAME>"
+        run: cmake --build . --config Debug
+
+      - name: Test
+        working-directory: ${{github.workspace}}/build
+        shell: bash
+        # Execute tests defined by the CMake configuration.  
+        # See https://cmake.org/cmake/help/latest/manual/ctest.1.html for more detail
+        run: ctest -C Debug
+
+      - name: Install
+        working-directory: ${{github.workspace}}/build
+        shell: bash
+        # Use CMake to "install" build artifacts (only interested in CMake registered targets) to our custom artifacts directory
+        run: cmake --install . --config Debug
+
+      # Only run last two steps if this is a release
+      - name: Release
+        if: github.event == 'release'
+        env:
+          CXX: ${{ matrix.cxx }}
+        # Use a bash shell so we can use the same syntax for environment variable
+        # access regardless of the host operating system
+        shell: bash
+        working-directory: ${{github.workspace}}/build
+        # Note the current convention is to use the -S and -B options here to specify source 
+        # and build directories, but this is only available with CMake 3.13 and higher.  
+        # The CMake binaries on the Github Actions machines are (as of this writing) 3.12
+        run: |
+          cmake $GITHUB_WORKSPACE -DCMAKE_BUILD_TYPE=Release -DCMAKE_INSTALL_PREFIX:PATH=$GITHUB_WORKSPACE/artifacts
+          cmake --build . --config Release
+          cmake --install . --config Release
+
+      # Only Upload releases
+      - name: Upload
+        if: github.event == 'release'
+        uses: actions/upload-artifact@v2
+        with:
+          name: build_${{ github.sha }}_${{ matrix.os }}_${{ matrix.cxx }}
+          path: ${{github.workspace}}/artifacts

CMakeLists.txt

@@ -96,7 +96,7 @@ set(PROJ_CLI_SOURCE "main.cpp")
 # C++ source files for unit tests
 file(GLOB TEST_SOURCES "tests/*.cpp")
 # Header files
-set(PROJ_HEADERS "proj/*.hpp")
+set(PROJ_HEADERS "proj/proj.hpp")
 
 # if project is a library
 add_library(proj ${PROJ_SOURCES})

README.md

@@ -1,5 +1,5 @@
 # CPP20-Cross-Platform-Template
-A template for a cross-platform C++20 project including CMake, unit-testing with Catch and cross-platform Travis-CI
+A template for a cross-platform C++20 project including CMake, unit-testing with Catch, cross-platform CI with Travis-CI/Github Actions and cross-platform release builds using Github Actions.
 
 ## What's included
 - CMake C++20 project skeleton, with strict warning flags enabled when using GCC or Clang.
@@ -9,6 +9,9 @@ A template for a cross-platform C++20 project including CMake, unit-testing with
     - macOS: Clang-10
     - Windows: MSVC 2019
     - 1 Additional build on Linux to check Doxygen documentation is well-formed
+- Github Action config file supporting:
+    - Building and running tests on the same Operating Systems and Compilers as Travis-CI (additionally, GCC-10 on macOS)
+    - Building Releases on each platform when a Github Release is published, uploading these as build Artifacts.
 - Doxygen config file with tweaks from the default config settings to provide a few more graphs (usage, caller/callee relationships) than are enabled by default.
 
 ## Usage