mirror of
https://github.com/Megghy/vtsuru.live.git
synced 2025-12-07 02:46:55 +08:00
123 lines
6.6 KiB
YAML
123 lines
6.6 KiB
YAML
########################################################################################
|
|
# "yarn install" composite action for yarn 3/4+ and "nodeLinker: node-modules" #
|
|
#--------------------------------------------------------------------------------------#
|
|
# Requirement: @setup/node should be run before #
|
|
# #
|
|
# Usage in workflows steps: #
|
|
# #
|
|
# - name: 📥 Monorepo install #
|
|
# uses: ./.github/actions/yarn-nm-install #
|
|
# with: #
|
|
# enable-corepack: false # (default = 'false') #
|
|
# cwd: ${{ github.workspace }}/apps/my-app # (default = '.') #
|
|
# cache-prefix: add cache key prefix # (default = 'default') #
|
|
# cache-node-modules: false # (default = 'false') #
|
|
# cache-install-state: false # (default = 'false') #
|
|
# #
|
|
# Reference: #
|
|
# - latest: https://gist.github.com/belgattitude/042f9caf10d029badbde6cf9d43e400a #
|
|
# #
|
|
# Versions: #
|
|
# - 1.1.0 - 22-07-2023 - Option to enable npm global cache folder. #
|
|
# - 1.0.4 - 15-07-2023 - Fix corepack was always enabled. #
|
|
# - 1.0.3 - 05-07-2023 - YARN_ENABLE_MIRROR to false (speed up cold start) #
|
|
# - 1.0.2 - 02-06-2023 - install-state default to false #
|
|
# - 1.0.1 - 29-05-2023 - cache-prefix doc #
|
|
# - 1.0.0 - 27-05-2023 - new input: cache-prefix #
|
|
########################################################################################
|
|
|
|
name: 'Monorepo install (yarn)'
|
|
description: 'Run yarn install with node_modules linker and cache enabled'
|
|
inputs:
|
|
cwd:
|
|
description: "Changes node's process.cwd() if the project is not located on the root. Default to process.cwd()"
|
|
required: false
|
|
default: '.'
|
|
cache-prefix:
|
|
description: 'Add a specific cache-prefix'
|
|
required: false
|
|
default: 'default'
|
|
cache-npm-cache:
|
|
description: 'Cache npm global cache folder often used by node-gyp, prebuild binaries (invalidated on lock/os/node-version)'
|
|
required: false
|
|
default: 'true'
|
|
cache-node-modules:
|
|
description: 'Cache node_modules, might speed up link step (invalidated lock/os/node-version/branch)'
|
|
required: false
|
|
default: 'false'
|
|
cache-install-state:
|
|
description: 'Cache yarn install state, might speed up resolution step when node-modules cache is activated (invalidated lock/os/node-version/branch)'
|
|
required: false
|
|
default: 'false'
|
|
enable-corepack:
|
|
description: 'Enable corepack'
|
|
required: false
|
|
default: 'true'
|
|
|
|
runs:
|
|
using: 'composite'
|
|
|
|
steps:
|
|
- name: ⚙️ Enable Corepack
|
|
if: inputs.enable-corepack == 'true'
|
|
shell: bash
|
|
working-directory: ${{ inputs.cwd }}
|
|
run: corepack enable
|
|
|
|
- name: ⚙️ Expose yarn config as "$GITHUB_OUTPUT"
|
|
id: yarn-config
|
|
shell: bash
|
|
working-directory: ${{ inputs.cwd }}
|
|
env:
|
|
YARN_ENABLE_GLOBAL_CACHE: 'false'
|
|
run: |
|
|
echo "CACHE_FOLDER=$(yarn config get cacheFolder)" >> $GITHUB_OUTPUT
|
|
echo "CURRENT_NODE_VERSION="node-$(node --version)"" >> $GITHUB_OUTPUT
|
|
echo "CURRENT_BRANCH=$(echo ${GITHUB_REF#refs/heads/} | sed -r 's,/,-,g')" >> $GITHUB_OUTPUT
|
|
echo "NPM_GLOBAL_CACHE_FOLDER=$(npm config get cache)" >> $GITHUB_OUTPUT
|
|
|
|
- name: ♻️ Restore yarn cache
|
|
uses: actions/cache@v3
|
|
id: yarn-download-cache
|
|
with:
|
|
path: ${{ steps.yarn-config.outputs.CACHE_FOLDER }}
|
|
key: yarn-download-cache-${{ inputs.cache-prefix }}-${{ hashFiles(format('{0}/yarn.lock', inputs.cwd), format('{0}/.yarnrc.yml', inputs.cwd)) }}
|
|
restore-keys: |
|
|
yarn-download-cache-${{ inputs.cache-prefix }}-
|
|
|
|
- name: ♻️ Restore node_modules
|
|
if: inputs.cache-node-modules == 'true'
|
|
id: yarn-nm-cache
|
|
uses: actions/cache@v3
|
|
with:
|
|
path: ${{ inputs.cwd }}/**/node_modules
|
|
key: yarn-nm-cache-${{ inputs.cache-prefix }}-${{ runner.os }}-${{ steps.yarn-config.outputs.CURRENT_NODE_VERSION }}-${{ steps.yarn-config.outputs.CURRENT_BRANCH }}-${{ hashFiles(format('{0}/yarn.lock', inputs.cwd), format('{0}/.yarnrc.yml', inputs.cwd)) }}
|
|
|
|
- name: ♻️ Restore global npm cache folder
|
|
if: inputs.cache-npm-cache == 'true'
|
|
id: npm-global-cache
|
|
uses: actions/cache@v3
|
|
with:
|
|
path: ${{ steps.yarn-config.outputs.NPM_GLOBAL_CACHE_FOLDER }}
|
|
key: npm-global-cache-${{ inputs.cache-prefix }}-${{ runner.os }}-${{ steps.yarn-config.outputs.CURRENT_NODE_VERSION }}-${{ hashFiles(format('{0}/yarn.lock', inputs.cwd), format('{0}/.yarnrc.yml', inputs.cwd)) }}
|
|
|
|
- name: ♻️ Restore yarn install state
|
|
if: inputs.cache-install-state == 'true' && inputs.cache-node-modules == 'true'
|
|
id: yarn-install-state-cache
|
|
uses: actions/cache@v3
|
|
with:
|
|
path: ${{ inputs.cwd }}/.yarn/ci-cache
|
|
key: yarn-install-state-cache-${{ inputs.cache-prefix }}-${{ runner.os }}-${{ steps.yarn-config.outputs.CURRENT_NODE_VERSION }}-${{ steps.yarn-config.outputs.CURRENT_BRANCH }}-${{ hashFiles(format('{0}/yarn.lock', inputs.cwd), format('{0}/.yarnrc.yml', inputs.cwd)) }}
|
|
|
|
- name: 📥 Install dependencies
|
|
shell: bash
|
|
working-directory: ${{ inputs.cwd }}
|
|
run: yarn install --immutable --inline-builds
|
|
env:
|
|
# Overrides/align yarnrc.yml options (v3, v4) for a CI context
|
|
YARN_ENABLE_GLOBAL_CACHE: 'false' # Use local cache folder to keep downloaded archives
|
|
YARN_ENABLE_MIRROR: 'false' # Prevent populating global cache for caches misses (local cache only)
|
|
YARN_NM_MODE: 'hardlinks-local' # Reduce node_modules size
|
|
YARN_INSTALL_STATE_PATH: '.yarn/ci-cache/install-state.gz' # Might speed up resolution step when node_modules present
|
|
# Other environment variables
|
|
HUSKY: '0' # By default do not run HUSKY install |