# Workflow for deploying the `forge doc` site to GitHub Pages
name: 📖 Docs

on:
  push:
    branches: [main, master]

  # 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: "pages"
  cancel-in-progress: true

jobs:
  build:
    runs-on: ubuntu-latest
    steps:
      - uses: actions/checkout@v2

      - name: Install Foundry
        uses: onbjerg/foundry-toolchain@v1
        with:
          version: nightly

      - name: Install dependencies
        run: forge install

      - name: Generate docs
        run: forge doc --build

      - name: Upload artifact
        uses: actions/upload-pages-artifact@v1
        with:
          path: ./docs/book

      ### deployed to https://{username}.github.io/{repo-name}/
      - name: Deploy to GitHub Pages
        id: deployment
        uses: actions/deploy-pages@v1