ci.yaml

name: CI

on:
  push:
    branches:
      - main
  pull_request:
    branches:
      - main

env:
  NODE_VERSION: '20.16.0'

jobs:
  format:
    runs-on: ubuntu-latest
    if: ${{ !startsWith(github.event.head_commit.message, 'docs') }}
    steps:
      - name: Checkout code
        uses: actions/checkout@v4

      - name: Set up Node.js
        uses: actions/setup-node@v4
        with:
          node-version: ${{ env.NODE_VERSION }}

      - name: Cache Node modules
        uses: actions/cache@v4
        id: cache-node-modules
        with:
          path: |
            node_modules
            ~/.npm
          key: ${{ runner.os }}-node-modules-${{ env.NODE_VERSION }}-${{ hashFiles('package-lock.json') }}
          restore-keys: |
            ${{ runner.os }}-node-modules-${{ env.NODE_VERSION }}-

      - name: Install dependencies
        run: npm ci

      - name: Run formatting tests
        run: npm run lint

  e2e:
    runs-on: ubuntu-latest

    services:
      mongo:
        image: mongo:6.0
        env:
          MONGO_INITDB_ROOT_USERNAME: docker
          MONGO_INITDB_ROOT_PASSWORD: mongopw
          MONGO_INITDB_DATABASE: nest-api-starter
        ports:
          - '27017:27017'

    if: ${{ !startsWith(github.event.head_commit.message, 'docs') }}
    needs: format # Ensures the format job completes before e2e job starts
    steps:
      - name: Checkout code
        uses: actions/checkout@v4

      - name: Set up Node.js
        uses: actions/setup-node@v4
        with:
          node-version: ${{ env.NODE_VERSION }}

      - name: Cache Node modules
        uses: actions/cache@v4
        id: cache-node-modules
        with:
          path: |
            node_modules
            ~/.npm
          key: ${{ runner.os }}-node-modules-${{ env.NODE_VERSION }}-${{ hashFiles('package-lock.json') }}
          restore-keys: |
            ${{ runner.os }}-node-modules-${{ env.NODE_VERSION }}-

      - name: Install dependencies
        run: npm ci

      - name: Run e2e tests
        run: npm run test:e2e