validate.yml

name: validate
on:
  push:
    branches:
      - '+([0-9])?(.{+([0-9]),x}).x'
      - 'master'
      - 'next'
      - 'next-major'
      - 'beta'
      - 'alpha'
      - '!all-contributors/**'
  pull_request: {}
jobs:
  prepare:
    name: 🎫 Prepare
    runs-on: ubuntu-latest
    steps:
      - name: ⬇️ Checkout repo
        uses: actions/checkout@v4

      - name: ⎔ Setup node
        uses: actions/setup-node@v4
        with:
          node-version: 20

      - name: 💾 Cache Node Modules
        id: node-cache
        uses: actions/cache@v4
        with:
          path: node_modules
          key: node-modules-${{ hashFiles('package-lock.json') }}

      - name: 📥 Download deps
        if: steps.node-cache.outputs.cache-hit != 'true'
        run: npm install

  lint:
    name: 🧼 ESLint
    runs-on: ubuntu-latest
    needs: prepare
    steps:
      - name: ⬇️ Checkout repo
        uses: actions/checkout@v4

      - name: ⎔ Setup node
        uses: actions/setup-node@v4
        with:
          node-version: 20

      - name: 💾 Cache Node Modules
        id: node-cache
        uses: actions/cache@v4
        with:
          path: node_modules
          key: node-modules-${{ hashFiles('package-lock.json') }}

      - name: 🧼 Lint
        run: npm run lint

  typescript:
    name: 🏗 TypeScript
    runs-on: ubuntu-latest
    needs: prepare
    steps:
      - name: ⬇️ Checkout repo
        uses: actions/checkout@v4

      - name: ⎔ Setup node
        uses: actions/setup-node@v4
        with:
          node-version: 20

      - name: 💾 Cache Node Modules
        id: node-cache
        uses: actions/cache@v4
        with:
          path: node_modules
          key: node-modules-${{ hashFiles('package-lock.json') }}

      - name: 💾 Cache Build
        id: lib-cache
        uses: actions/cache@v4
        with:
          path: lib
          key: lib-${{github.sha}}

      - name: 🧙‍♂️ Build Index
        run: npm run build:index

      - name: 🏗 TypeScript
        run: npm run build

  test:
    # ignore all-contributors PRs
    if: ${{ !contains(github.head_ref, 'all-contributors') }}
    strategy:
      matrix:
        node: [18, 20, 21]
    runs-on: ubuntu-latest
    needs: prepare
    name: 🧪 Test
    steps:
      - name: 🛑 Cancel Previous Runs
        uses: styfle/cancel-workflow-action@0.11.0
        with:
          access_token: ${{ secrets.GITHUB_TOKEN }}

      - name: ⬇️ Checkout repo
        uses: actions/checkout@v4

      - name: ⎔ Setup node
        uses: actions/setup-node@v4
        with:
          node-version: ${{ matrix.node }}

      - name: 💾 Cache Node Modules
        id: node-cache
        uses: actions/cache@v4
        with:
          path: node_modules
          key: node-modules-${{ hashFiles('package-lock.json') }}

      - name: 🧪 Test
        run: npm test

      - name: ⬆️ Upload coverage report
        uses: codecov/codecov-action@v3

  document:
    runs-on: ubuntu-latest
    needs: [typescript, lint, test]
    name: 📚 Document
    if:
      ${{ github.repository == 'arcath/utils' &&
      contains('refs/heads/master,refs/heads/beta,refs/heads/next,refs/heads/alpha',
      github.ref) && github.event_name == 'push' }}
    steps:
      - name: ⬇️ Checkout repo
        uses: actions/checkout@v4

      - name: ⎔ Setup node
        uses: actions/setup-node@v4
        with:
          node-version: 20

      - name: 💾 Cache Node Modules
        id: node-cache
        uses: actions/cache@v4
        with:
          path: node_modules
          key: node-modules-${{ hashFiles('package-lock.json') }}

      - name: 🧙‍♂️ Build Index
        run: npm run build:index

      - name: 📚 Build Docs
        run: npm run document

      - name: 🚀 Deploy
        uses: JamesIves/github-pages-deploy-action@v4
        with:
          branch: gh-pages
          folder: docs

  release:
    name: 🚀 Release
    if:
      ${{ github.repository == 'arcath/utils' &&
      contains('refs/heads/master,refs/heads/beta,refs/heads/next,refs/heads/alpha',
      github.ref) && github.event_name == 'push' }}
    runs-on: ubuntu-latest
    needs: [typescript, lint, test]
    steps:
      - name: ⬇️ Checkout repo
        uses: actions/checkout@v4

      - name: 💾 Cache Build
        id: lib-cache
        uses: actions/cache@v4
        with:
          path: lib
          key: lib-${{github.sha}}

      - name: 🔍 Inspect Lib
        run: ls -R lib/

      - name: 🚢 Release
        uses: cycjimmy/semantic-release-action@v3
        with:
          semantic_version: 17
          branches: |
            [
              '+([0-9])?(.{+([0-9]),x}).x',
              'master',
              'next',
              'next-major',
              {name: 'beta', prerelease: true},
              {name: 'alpha', prerelease: true}
            ]
        env:
          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
          NPM_TOKEN: ${{ secrets.NPM_TOKEN }}