docs.yaml

name: docs

concurrency:
  group: ${{ github.workflow }}-${{ github.ref }}
  cancel-in-progress: true

on:
  pull_request:
    paths:
      - "docs/**"
      - ".github/workflows/docs.yaml"
    branches:
      - main
  push:
    paths:
      - "docs/**"
      - ".github/workflows/docs.yaml"
    branches:
      - main

jobs:
  build:
    defaults:
      run:
        working-directory: docs

    runs-on: ubuntu-latest

    steps:
      - name: 📚 Git Checkout
        uses: actions/checkout@v4

      - name: ⚙️ Setup Node
        uses: actions/setup-node@v4
        with:
          node-version: 18.x
          cache: npm
          cache-dependency-path: docs/package-lock.json

      - name: 📦 Install Dependencies
        run: npm ci

      - name: ✨ Check Format
        run: npm run format:check

      - name: 🧹 Lint
        run: npm run lint

      - name: 👷 Build website
        run: npm run build

  deploy:
    needs: build

    permissions:
      contents: write

    runs-on: ubuntu-latest

    if: ${{ github.repository == 'flutter/news_toolkit' && github.event_name == 'push' && github.ref == 'refs/heads/main' }}

    defaults:
      run:
        working-directory: docs

    steps:
      - name: 📚 Git Checkout
        uses: actions/checkout@v4

      - name: ⚙️ Setup Node
        uses: actions/setup-node@v4
        with:
          node-version: 18.x
          cache: npm
          cache-dependency-path: docs/package-lock.json

      - name: 📦 Install Dependencies
        run: npm ci

      - name: ✨ Check Format
        run: npm run format:check

      - name: 🧹 Lint
        run: npm run lint

      - name: 👷 Build website
        run: npm run build

      - name: ☁️ Deploy to GitHub Pages
        uses: peaceiris/actions-gh-pages@4f9cc6602d3f66b9c108549d475ec49e8ef4d45e
        with:
          github_token: ${{ secrets.GITHUB_TOKEN }}
          publish_dir: ./docs/build
          user_name: github-actions[bot]
          user_email: 41898282+github-actions[bot]@users.noreply.github.com