# Simple workflow for deploying static content to GitHub Pages name: Deploy documentation on: # Runs on pushes targeting the default branch push: branches: ["master"] paths: - "**.rs" # 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: # Single deploy job since we're just deploying deploy: environment: name: github-pages url: ${{ steps.deployment.outputs.page_url }} runs-on: ubuntu-latest steps: - name: Checkout uses: actions/checkout@v4 - name: Install dependencies run: sudo apt update && sudo apt install libnotify-dev clang pkg-config -y - uses: cachix/install-nix-action@v31 - uses: cachix/cachix-action@v16 with: name: devenv - name: Install devenv.sh run: nix profile add nixpkgs#devenv - name: Setup Pages uses: actions/configure-pages@v5 - name: Generate docs run: | devenv shell cargo doc --no-deps echo '' > target/doc/index.html - name: Upload artifact uses: actions/upload-pages-artifact@v3 with: path: './target/doc/' - name: Deploy to GitHub Pages id: deployment uses: actions/deploy-pages@v5