Improve Branding and Update README #63
Workflow file for this run
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| name: CI | |
| on: | |
| push: | |
| branches: | |
| - main | |
| pull_request: | |
| branches: | |
| - main | |
| jobs: | |
| build: | |
| runs-on: ubuntu-latest | |
| steps: | |
| - name: Checkout code | |
| uses: actions/checkout@v4 | |
| - name: Setup Conan | |
| uses: hankhsu1996/setup-conan@v1 | |
| with: | |
| cache-dependencies: true | |
| cache-tool: true | |
| - name: Setup Ninja | |
| uses: seanmiddleditch/gha-setup-ninja@v5 | |
| - name: Install dependencies | |
| run: | | |
| conan profile detect --force | |
| conan install . --output-folder=build --build=missing | |
| - name: Configure CMake and build project | |
| run: | | |
| cmake --preset default | |
| cmake --build --preset default | |
| - name: Upload necessary build files | |
| uses: actions/upload-artifact@v4 | |
| with: | |
| name: build-files | |
| path: | | |
| build/CMakeCache.txt | |
| build/CTestTestfile.cmake | |
| build/tests/tests | |
| retention-days: 7 | |
| test: | |
| needs: build | |
| runs-on: ubuntu-latest | |
| steps: | |
| - name: Checkout code | |
| uses: actions/checkout@v4 | |
| - name: Download necessary build files | |
| uses: actions/download-artifact@v4 | |
| with: | |
| name: build-files | |
| path: build | |
| - name: Add execute permissions to test binary | |
| run: chmod +x build/tests/tests | |
| - name: Run tests | |
| run: ctest --preset default --test-dir build | |
| docs: | |
| runs-on: ubuntu-latest | |
| container: hankhsu1996/doxygen:1.11.0 | |
| steps: | |
| - name: Checkout repository | |
| uses: actions/checkout@v4 | |
| with: | |
| submodules: recursive | |
| - name: Generate Doxygen documentation | |
| run: doxygen Doxyfile | |
| - name: Upload Doxygen documentation artifacts | |
| uses: actions/upload-artifact@v4 | |
| with: | |
| name: doxygen-docs | |
| path: docs/generated/html | |
| deploy: | |
| if: github.event_name == 'push' && github.ref == 'refs/heads/main' | |
| needs: docs | |
| runs-on: ubuntu-latest | |
| permissions: | |
| contents: write | |
| steps: | |
| - name: Checkout repository | |
| uses: actions/checkout@v4 | |
| - name: Download Doxygen documentation artifacts | |
| uses: actions/download-artifact@v4 | |
| with: | |
| name: doxygen-docs | |
| path: docs/generated/html | |
| - name: Deploy to GitHub Pages | |
| uses: peaceiris/actions-gh-pages@v3 | |
| with: | |
| github_token: ${{ secrets.GITHUB_TOKEN }} | |
| publish_dir: ./docs/generated/html | |
| publish_branch: gh-pages |