Deploy API docs to GitHub Pages #10
Workflow file for this run
This file contains hidden or 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 API docs to GitHub Pages | |
| on: | |
| # Allows you to run this workflow manually from the Actions tab | |
| workflow_dispatch: | |
| # push: | |
| # branches: | |
| # - master | |
| # 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: | |
| runs-on: ubuntu-24.04 | |
| steps: | |
| - name: Install Dependencies on Linux | |
| run: | | |
| sudo apt update -qq | |
| sudo apt install -y doxygen graphviz | |
| - name: Install Qt | |
| uses: jurplel/install-qt-action@v4 | |
| with: | |
| aqtversion: null # use whatever the default is | |
| version: 6.6.0 | |
| cache: true | |
| documentation: true | |
| doc-archives: 'qtcore' | |
| - name: Checkout sources | |
| uses: actions/checkout@v6 | |
| with: | |
| submodules: recursive | |
| - name: Configure project | |
| run: > | |
| cmake -S . -B ./build | |
| -DASQL_DRIVER_POSTGRES=OFF | |
| -DASQL_DRIVER_MYSQL=OFF | |
| -DASQL_DRIVER_ODBC=OFF | |
| -DASQL_BUILD_DEMOS=OFF | |
| -DBUILD_TESTING=OFF | |
| -DDOCS_QTDOCSDIR="${{ runner.workspace }}/Qt/Docs/Qt-6.6.0" | |
| - name: Create docs | |
| run: cmake --build ./build --target docs | |
| - name: Upload artifact | |
| uses: actions/upload-pages-artifact@v7 | |
| with: | |
| path: build/docs/html/ | |
| # Deployment job, what was uploaded to artifact | |
| deploy: | |
| needs: build | |
| runs-on: ubuntu-latest | |
| environment: | |
| name: github-pages | |
| url: ${{ steps.deployment.outputs.page_url }} | |
| steps: | |
| - name: Deploy to GitHub Pages | |
| id: deployment | |
| uses: actions/deploy-pages@v5 |