Add a reference to the GitHub flow guide #21
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: Deploy Jekyll and Doxygen | |
| on: | |
| push: | |
| # branches: [$default-branch] | |
| branches: [docs_in_main] | |
| # Allows you to run this workflow manually from the Actions tab | |
| workflow_dispatch: | |
| # Sets permissions of the GITHUB_TOKEN to allow deployment to GitHub Pages | |
| permissions: | |
| contents: read | |
| pages: write | |
| id-token: write | |
| # Allow only one concurrent deployment, skipping runs queued between the run in-progress and latest queued. | |
| # However, do NOT cancel in-progress runs as we want to allow these production deployments to complete. | |
| concurrency: | |
| group: "pages" | |
| cancel-in-progress: false | |
| jobs: | |
| # Build job | |
| build: | |
| runs-on: ubuntu-22.04 | |
| env: | |
| VCPKG_ROOT: "vcpkg" | |
| VCPKG_BINARY_SOURCES: "clear;nuget,GitHub,readwrite" | |
| steps: | |
| - name: Checkout | |
| uses: actions/checkout@v3 | |
| - name: Setup Pages | |
| uses: actions/configure-pages@v3 | |
| - name: Build with Jekyll | |
| uses: actions/jekyll-build-pages@v1 | |
| with: | |
| source: ./docs | |
| destination: ./_site | |
| - name: Install build dependencies | |
| run: | | |
| sudo apt update | |
| sudo apt upgrade -y | |
| sudo apt install --no-install-recommends build-essential ninja-build doxygen graphviz | |
| - name: Install VCPKG | |
| run: | | |
| git clone https://github.com/Microsoft/vcpkg.git | |
| cd vcpkg | |
| ./bootstrap-vcpkg.sh -disableMetrics | |
| - name: Configure HealthGPS | |
| run: | | |
| cmake --preset=linux-release | |
| - name: Build with doxygen | |
| run: | | |
| ninja -C out/build/linux-release/ doxygen-docs | |
| sudo cp -r out/build/linux-release/src/html _site/api | |
| - name: Upload artifact | |
| uses: actions/upload-pages-artifact@v2 | |
| # Deployment job | |
| deploy: | |
| environment: | |
| name: github-pages | |
| url: ${{ steps.deployment.outputs.page_url }} | |
| runs-on: ubuntu-latest | |
| needs: build | |
| steps: | |
| - name: Deploy to GitHub Pages | |
| id: deployment | |
| uses: actions/deploy-pages@v2 |