action.yml

name: 'Cached Node Modules'
description: 'A simple action to cache node_modules or install them if they are not cached'
inputs:
  nodeVersion: # id of input
    description: 'Node.js version to use in the cache key'
    default: '20'
  build:
    description: 'Whether to build the packages or not'
    default: 'true'
outputs:
  cache-hit:
    description: "Whether the cache was hit or not"
    value: ${{ steps.cache-node-modules.outputs.cache-hit }}
runs:
  using: "composite"
  steps:
    - name: Install npm
      # We need to keep this npm version until we drop Node.js 16 support because Node.js 16 doesn't support npm 10
      run: npm i -g npm@next-9
      shell: bash
    - name: Cache node modules
      id: cache-node-modules
      uses: actions/cache@13aacd865c20de90d75de3b17ebe84f7a17d57d2 # v4.0.0
      with:
        path: '**/node_modules'
        # Use the combo between node version, name, and SHA-256 hash of the lock file as cache key so that
        # if one of them changes the cache is invalidated/discarded
        key: ${{ inputs.nodeVersion }}-cache-utilities-node-modules-${{ hashFiles('./package-lock.json') }}
    - name: Install dependencies
      # We can skip the installation if there was a cache hit
      if: steps.cache-node-modules.outputs.cache-hit != 'true'
      run: npm ci
      shell: bash
    - name: Build packages
      # Regardless of whether the cache was hit or not, we need to build the packages, unless the caller says otherwise
      if: inputs.build == 'true'
      # We build the commons and jmspath packages first, then the others in parallel to speed up the process
      # even though we could just run `npm run build` in the root folder and build them in
      # sequence, but still in the correct order.
      run: |
        npm run build -w packages/commons 
        npm run build -w packages/jmespath
        npm run build -w packages/logger & \
        npm run build -w packages/tracer & \
        npm run build -w packages/metrics & \
        npm run build -w packages/parameters & \
        npm run build -w packages/idempotency & \
        npm run build -w packages/batch & \
        npm run build -w packages/testing & \
        npm run build -w packages/parser
      shell: bash