deploy.yml

name: Build and deploy

on:
  push:
    branches: [ mkdocs ]

jobs:
  codespell:
    name: Check for spelling errors
    runs-on: ubuntu-latest

    steps:
      - name: Checkout
        uses: actions/checkout@v3

      - name: Codespell
        uses: codespell-project/actions-codespell@v1

  cspell:
    name: Check for spelling errors (cspell)
    runs-on: ubuntu-latest

    steps:
      - name: Checkout
        uses: actions/checkout@v3

      - name: Set up Node
        uses: actions/setup-node@v4
        with:
          node-version: '20'

      - name: Install dependencies
        run: npm ci

      - name: Cspell
        run: npx cspell --no-progress "**/*.md"

  build:
    needs: [codespell, cspell]

    runs-on: ubuntu-latest

    steps:
    - uses: actions/checkout@v2
      with:
        path: mkdocs
    - name: Set up Python
      uses: actions/setup-python@v4
    - name: Setup Git & Install dependencies
      run: |
        git config --global user.email "nipreps@gmail.com"
        git config --global user.name "nipreps-bot"
        python -m pip install --upgrade pip
        pip install -r mkdocs/requirements.txt
    - uses: actions/checkout@v2
      with:
        ref: gh-pages
        path: www
    - name: Clean up master
      run: |
        cd www/
        git ls-files -z | xargs -0 git rm -f
    - name: Build
      env:
        JUPYTER_PLATFORM_DIRS: "1"
        NO_MKDOCS_2_WARNING: "true"
        # codespell/cspell jobs above already checked this push; skip the
        # build's own pre-build hooks so the build doesn't redo the same check.
        SKIP_SPELLCHECK_HOOKS: "1"
      run: |
        cd mkdocs/
        mkdocs build -d ../www/
        touch ../www/.nojekyll
    - name: Deploy
      run: |
        cd www/
        git add -A
        git commit -m "auto: deploy new website" || echo "Nothing to commit, site is unchanged"
        git push