github-pages.yml

name: GitHub Pages
on:
  push:
    branches: ["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 one concurrent deployment
concurrency:
  group: "github-pages"
  cancel-in-progress: true
jobs:
  build:
    runs-on: ubuntu-latest
    steps:
      - name: Checkout
        uses: actions/checkout@v3
        with:
          submodules: recursive
      - name: Setup Pages
        uses: actions/configure-pages@v2
      - uses: actions/setup-python@v2
      - name: Install rust
        uses: actions-rs/toolchain@v1
        with:
          toolchain: stable
          profile: minimal
          override: true
      - name: Run tests
        env:
          CARGO_INCREMENTAL: 0
        run: |
          cargo test --doc
          cargo test --lib
        id: test
      - name: Invoke cargo doc
        run: |
          rm -rf ./_site
          cargo doc --workspace --no-deps
          rm -f target/doc/.lock
          cp -r target/doc _site
          echo "generating site index"
          python3 .github/site/siteindex.py xps_gateway registry messaging inbox > _site/index.html
          echo "Taking care of pedantic permissions requirements required by GitHub Pages"
          chmod -R +rX _site
        id: docgen
      - 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@v3