docs.yml

name: PouchDB Docs

on:
  push:
    paths:
      - 'package.json'
      - 'bin/**'
      - 'docs/**'
  pull_request:
    branches: [master]
    paths:
      - 'package.json'
      - 'bin/**'
      - 'docs/**'
  workflow_dispatch:

# Set permissions of the GITHUB_TOKEN to allow deployment to GitHub Pages
permissions:
  contents: read
  pages: write
  id-token: write

# Allow only one concurrent deployment
concurrency:
  group: "pages"
  cancel-in-progress: true

jobs:

  test-docs:
    runs-on: ubuntu-20.04
    steps:
      - name: Checkout
        uses: actions/checkout@v3
      - uses: ./.github/actions/install-deps
      - uses: ruby/setup-ruby@v1
        with:
          ruby-version: 2.7
          bundler-cache: true
      - run: sudo gem install bundler -v 2.1.4
      - run: npm run install-jekyll
      - run: BUILD=1 npm run build-site
      - name: upload docs as artifact
        if: ${{ github.event.workflow_dispatch }}
        uses: actions/upload-pages-artifact@v2
        with:
          path: docs/_site

  deploy-pages:
    if: ${{ github.event.workflow_dispatch }}
    environment:
      name: github-pages
      url: ${{ steps.deployment.outputs.page_url }}
    runs-on: ubuntu-latest
    needs: test-docs
    steps:
      - name: Deploy to GitHub Pages
        id: deployment
        uses: actions/deploy-pages@v2

  # This job is used to allow branch protection rules to depend on a single outcome
  # rather than needing to be modified every time the build matrix changes.
  #
  # It is duplicated in both ci.yml and docs.yml to allow for a single github
  # branch protection rule to be fulfilled by either workflow.
  #
  # See: https://github.com/orgs/community/discussions/26733
  # See: https://github.com/marketplace/actions/alls-green
  all-actions-green:
    if: always()

    needs:
      - test-docs

    runs-on: ubuntu-latest

    steps:
    - name: Check that all other jobs pass
      uses: re-actors/alls-green@release/v1
      with:
        jobs: ${{ toJSON(needs) }}