docs.yml

name: Documentation

on:
  push:
    branches:
      - main
  workflow_dispatch:

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

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

jobs:
  build:
    environment:
      name: github-pages
    runs-on: ubuntu-latest
    steps:
      - name: Checkout
        uses: actions/checkout@v4

      - name: Setup .NET
        uses: actions/setup-dotnet@v5
        with:
          dotnet-version: 9.0.x

      - name: Install DocFX
        run: dotnet tool update -g docfx

      - name: Build docs
        run: docfx docs/docfx.json

      - name: Add IndexNow key file
        run: |
          key="${{ secrets.INDEXNOW_KEY }}"

          if [ -z "$key" ]; then
            echo "INDEXNOW_KEY secret is not set; skipping IndexNow key file generation."
            exit 0
          fi

          printf '%s\n' "$key" > "docs/_site/${key}.txt"

      - name: Fix README images
        run: |
          mkdir -p docs/_site/docs/images
          cp -r docs/images/* docs/_site/docs/images/

      - name: Upload artifact
        uses: actions/upload-pages-artifact@v5
        with:
          path: docs/_site

  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@v4

      - name: Notify IndexNow
        run: |
          key="${{ secrets.INDEXNOW_KEY }}"

          if [ -z "$key" ]; then
            echo "INDEXNOW_KEY secret is not set; skipping IndexNow notification."
            exit 0
          fi

          site="https://aalmada.github.io/BookStore"
          key_location="${site}/${key}.txt"

          # Notify IndexNow about the homepage and sitemap after each deployment.
          curl -fsS "https://api.indexnow.org/indexnow?url=${site}/&key=${key}&keyLocation=${key_location}"
          curl -fsS "https://api.indexnow.org/indexnow?url=${site}/sitemap.xml&key=${key}&keyLocation=${key_location}"