pages.yml

# Builds the landing page and publishes it with GitHub Pages on every push to main, and once a week so that
# What's new (read from the GitHub API at build time) stays fresh.
# In the repository's Settings > Pages, the source must be "GitHub Actions" and the custom domain
# docs.source-robotics.com (with this source no CNAME file is needed).
name: pages

on:
  push:
    branches: [main]
  schedule:
    - cron: "17 6 * * 1"     # Mondays: What's new is read from GitHub at build time
  workflow_dispatch:

permissions:
  contents: read
  pages: write
  id-token: write

concurrency:
  group: pages
  cancel-in-progress: false

jobs:
  build:
    runs-on: ubuntu-latest
    steps:
      - uses: actions/checkout@v4
      - uses: actions/setup-python@v5
        with:
          python-version: "3.11"
          cache: pip
      - run: pip install -r requirements.txt
      - run: mkdocs build --strict
        env:
          GITHUB_TOKEN: ${{ github.token }}   # the What's new hook's API calls, above the anonymous rate limit
      - uses: actions/upload-pages-artifact@v3
        with:
          path: site

  deploy:
    needs: build
    runs-on: ubuntu-latest
    environment:
      name: github-pages
      url: ${{ steps.deployment.outputs.page_url }}
    steps:
      - id: deployment
        uses: actions/deploy-pages@v4