ci-cd.yml

name: CI/CD

on:
    workflow_dispatch:
    push: # Runs whenever a commit is pushed to the repository

concurrency:
    group: "${{ github.workflow }} @ ${{ github.event.pull_request.head.label || github.head_ref || github.ref }}"
    cancel-in-progress: true

permissions:
    contents: write # publish a GitHub release
    pages: write # deploy to GitHub Pages
    issues: write # comment on released issues
    pull-requests: write # comment on released pull requests

jobs:
    setup:
        runs-on: ubuntu-latest
        env:
            TRIGGER_DEPLOY: ${{ startsWith(github.ref, 'refs/heads/master') }}
            DETECT_CHROMEDRIVER_VERSION: "true"
            JEST_JUNIT_OUTPUT_DIR: test-results
            NODE_OPTIONS: --max-old-space-size=4000
        steps:
            - uses: actions/checkout@v4
            - uses: wagoid/commitlint-github-action@v5
              if: github.event_name == 'pull_request'
            - uses: actions/setup-node@v3
              with:
                  cache: "npm"
                  node-version-file: ".nvmrc"
            - name: Info
              run: |
                  cat <<EOF
                  Node version: $(node --version)
                  NPM version: $(npm --version)
                  GitHub ref: ${{ github.ref }}
                  GitHub head ref: ${{ github.head_ref }}
                  EOF
            - name: Install Dependencies
              run: npm install
            - name: Lint
              run: |
                npm run test:lint -- --quiet --output-file test-results/eslint/results.xml --format junit
            - name: Store Lint Results
              uses: actions/upload-artifact@v3
              with:
                name: lint-output
                path: ./test-results/*
            - name: Cache node_modules
              id: cache-nodemodules
              uses: actions/cache@v3
              with:
                path: 
                    node_modules
                key: ${{ runner.os }}-node-${{ hashFiles('package-lock.json') }}
            - name: Cache src/generated
              id: cache-generated
              uses: actions/cache@v3
              with:
                path: 
                    src/generated
                key: ${{ runner.os }}-generated-${{ hashFiles('package-lock.json') }}
            - name: Cache static/microbit
              id: cache-static
              uses: actions/cache@v3
              with:
                path: 
                    static/microbit
                key: ${{ runner.os }}-microbit-${{ hashFiles('package-lock.json') }}
    test-unit:
        needs: setup
        runs-on: ubuntu-latest
        env:
            JEST_JUNIT_OUTPUT_NAME: unit-results.xml
            JEST_JUNIT_OUTPUT_DIR: test-results/unit
        steps:
            - uses: actions/checkout@v4
            - name: Cache NPM dependencies
              uses: actions/cache@v3
              with:
                path: 
                    node_modules
                key: ${{ runner.os }}-node-${{ hashFiles('package-lock.json') }}
            - name: Run Unit Tests
              run: npm run test:unit -- --reporters="default" --reporters="jest-junit" --coverage --coverageReporters=text --coverageReporters=lcov --maxWorkers="2"
            - name: Store Unit Test Results
              uses: actions/upload-artifact@v3
              with:
                name: unit-test-output
                path: ./test-results/*
    build:
        needs: setup
        env: 
            NODE_OPTIONS: --max-old-space-size=4000
            DETECT_CHROMEDRIVER_VERSION: "true"
        runs-on: ubuntu-latest
        steps:
            - uses: actions/checkout@v4
            - uses: actions/setup-node@v3
              with:
                cache: "npm"
                node-version-file: ".nvmrc"
            - name: Retrieve node_modules
              uses: actions/cache@v3
              with:
                path: 
                    node_modules
                key: ${{ runner.os }}-node-${{ hashFiles('package-lock.json') }}
            - name: Retrieve src/generated
              uses: actions/cache@v3
              with:
                path: 
                    src/generated
                key: ${{ runner.os }}-generated-${{ hashFiles('package-lock.json') }}
            - name: Retireve static/microbit
              uses: actions/cache@v3
              with:
                path: 
                    static/microbit
                key: ${{ runner.os }}-microbit-${{ hashFiles('package-lock.json') }}
            - name: Run Build
              run: npm run build
            - name: Cache Build Directory
              uses: actions/cache@v3
              with:
                path: 
                    static/microbit
                key: ${{ runner.os }}-build-${{ hashFiles('package-lock.json') }}
            - name: Store Build Results
              uses: actions/upload-artifact@v3
              with:
                name: build-output
                path: ./build