Enhance caching in setup-node with automatic package manager detection by @priya-kinthali in #1348
This update, introduces automatic caching when a valid packageManager field is present in your package.json. This aims to improve workflow performance and make dependency management more seamless.
To disable this automatic caching, set package-manager-cache: false
Add architecture to cache key by @pengx17 in #843
This addresses issues with caching by adding the architecture (arch) to the cache key, ensuring that cache keys are accurate to prevent conflicts.
Note: This change may break previous cache keys as they will no longer be compatible with the new format.
Upgrade @actions/cache to 4.0.3 by @gowridurgad in #1270
In scope of this release we updated actions/cache package to ensure continued support and compatibility, as older versions of the package are now deprecated. For more information please refer to the toolkit/cache.
In scope of this release, the filter was removed within the cache-save step by @dmitry-shibanov in #831. It is filtered and checked in the toolkit/cache library.
In scope of this release we added a logic to save an additional cache path for yarn 3 (related pull request and feature request). Moreover, we added functionality to use all the sub directories derived from cache-dependency-path input and add detect all dependencies directories to cache (related pull request and feature request).
Besides, we made such changes as:
Replace workflow badge with new badge by @jongwooo in #653
In scope of this release we add support for engines.node. The action will be able to grab the version form package.json#engines.node. #485. Moreover, we added support for Volta
In scope of this release we fixed bugs related to the pnpm 7.5.1 output issue from pnpm store path #545. Moreover we fixed the issue with falling on node-version output #540.
v3.4.0: Add support for asdf format and update actions/cache version to 3.0.0
In scope of this release we updated actions/cache package as the new version contains fixes for caching error handling. Moreover, we added support for asdf format as Node.js version file #373. Besides, we introduced new output node-version and added npm-shrinkwrap.json to dependency file patterns: #439
In scope of this release we added support for lts/-n aliases, improve logic for current, latest and node aliases to handle them from toolcache, update ncc package.
In scope of this release we added support for caching from GHES 3.5 and fixed download issue for files > 2GB during restore. Besides, we updated actions/cache dependency to 2.0.0 version.
In scope of this release we fix logic of error handling related to caching (#358) and (#359).
In the previous behaviour we relied on stderr output to throw error. The warning messages from package managers can be written to the stderr's output. For now the action will throw an error only if exit code differs from zero. Besides, we add logic to сatch and log unhandled exceptions.
In scope of this release we add the node-version-file input and update actions/cache dependency to the latest version.
Adding Node.js version file support
The new input (node-version-file) provides functionality to specify the path to the file containing Node.js's version with such behaviour:
If the file does not exist the action will throw an error.
If you specify both node-version and node-version-file inputs, the action will use value from the node-version input and throw the following warning: Both node-version and node-version-file inputs are specified, only node-version will be used.
For now the action does not support all of the variety of values for Node.js version files. The action can handle values according to the documentation and values with v prefix (v14)
steps:
- uses: actions/checkout@v2
- name: Setup node from node version fileuses: actions/setup-node@v2with:
node-version-file: '.nvmrc'
- run: npm install
- run: npm test
Update actions/cache dependency to 1.0.8 version.
We updated actions/cache dependency to the latest version (1.0.8). For more information please refer to the toolkit/cache.
This release introduces a new output: cache-hit (#327).
The cache-hit output contains boolean value indicating that an exact match was found for the key. It shows that the action uses already existing cache or not. The output is available only if cache is enabled.
v2.4.0: Support caching for mono repos and repositories with complex structure
This release introduces dependency caching support for mono repos and repositories with complex structure (#305).
By default, the action searches for the dependency file (package-lock.json or yarn.lock) in the repository root. Use the cache-dependency-path input for cases when multiple dependency files are used, or they are located in different subdirectories. This input supports wildcards or a list of file names for caching multiple dependencies.
We had to disable pre-cached Node.js usage in the previous version due to the broken image cache. Now cache is fixed, so we can safely enable its usage again.
Thank you for understanding.
This release introduces dependency caching support for the pnpm package manager (#278).
Caching pnpm dependencies:
# This workflow uses actions that are not certified by GitHub.# They are provided by a third-party and are governed by# separate terms of service, privacy policy, and support# documentation.steps:
- uses: actions/checkout@v2
- uses: pnpm/action-setup@646cdf48217256a3d0b80361c5a50727664284f2with:
version: 6.10.0
- uses: actions/setup-node@v2with:
node-version: '14'cache: 'pnpm'
- run: pnpm install
- run: pnpm test
NOTE: pnpm caching support requires pnpm version >= 6.10.0
v2.2.0: Support caching dependencies and LTS aliases
The node-version input supports the following syntax:
major versions: 12, 14, 16
more specific versions: 10.15, 14.2.0, 16.3.0
nvm LTS syntax: lts/erbium, lts/fermium, lts/*
Caching dependencies
The action has a built-in functionality for caching and restoring npm/yarn dependencies. Supported package managers are npm, yarn. The cache input is optional, and caching is turned off by default.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
This PR contains the following updates:
Release Notes
actions/setup-node (actions/setup-node)v7.0.0
Compare Source
What's Changed
Enhancements:
Bug fixes:
Documentation updates:
Dependency update:
New Contributors
Full Changelog: actions/setup-node@v6...v7.0.0
v7
Compare Source
v6.5.0
Compare Source
What's Changed
Full Changelog: actions/setup-node@v6.4.0...v6.5.0
v6.4.0
Compare Source
What's Changed
Dependency updates:
New Contributors
Full Changelog: actions/setup-node@v6...v6.4.0
v6.3.0
Compare Source
What's Changed
Enhancements:
Dependency updates:
Bug fixes:
New Contributors
Full Changelog: actions/setup-node@v6...v6.3.0
v6.2.0
Compare Source
What's Changed
Documentation
Dependency updates:
New Contributors
Full Changelog: actions/setup-node@v6...v6.2.0
v6.1.0
Compare Source
What's Changed
Enhancement:
Dependency updates:
Documentation update:
Full Changelog: actions/setup-node@v6...v6.1.0
v6.0.0
Compare Source
What's Changed
Breaking Changes
Dependency Upgrades
Full Changelog: actions/setup-node@v5...v6.0.0
v6
Compare Source
v5.0.0
Compare Source
What's Changed
Breaking Changes
This update, introduces automatic caching when a valid packageManager field is present in your package.json. This aims to improve workflow performance and make dependency management more seamless.
To disable this automatic caching, set package-manager-cache: false
Make sure your runner is on version v2.327.1 or later to ensure compatibility with this release. See Release Notes
Dependency Upgrades
New Contributors
Full Changelog: actions/setup-node@v4...v5.0.0
v5
Compare Source
v4.4.0
Compare Source
What's Changed
Bug fixes:
Enhancement:
Dependency update:
New Contributors
Full Changelog: actions/setup-node@v4...v4.4.0
v4.3.0
Compare Source
What's Changed
Dependency updates
New Contributors
Full Changelog: actions/setup-node@v4...v4.3.0
v4.2.0
Compare Source
What's Changed
New Contributors
Full Changelog: actions/setup-node@v4...v4.2.0
v4.1.0
Compare Source
What's Changed
This addresses issues with caching by adding the architecture (arch) to the cache key, ensuring that cache keys are accurate to prevent conflicts.
Note: This change may break previous cache keys as they will no longer be compatible with the new format.
New Contributors
Full Changelog: actions/setup-node@v4...v4.1.0
v4.0.4
Compare Source
What's Changed
Documentation changes:
New Contributors
Full Changelog: actions/setup-node@v4...v4.0.4
v4.0.3
Compare Source
What's Changed
Bug fixes:
Documentation changes:
Dependency updates:
New Contributors
Full Changelog: actions/setup-node@v4...v4.0.3
v4.0.2
Compare Source
What's Changed
New Contributors
Full Changelog: actions/setup-node@v4.0.1...v4.0.2
v4.0.1
Compare Source
What's Changed
New Contributors
Full Changelog: actions/setup-node@v4...v4.0.1
v4.0.0
Compare Source
What's Changed
In scope of this release we changed version of node runtime for action from node16 to node20 and updated dependencies in #866
Besides, release contains such changes as:
New Contributors
Full Changelog: actions/setup-node@v3...v4.0.0
v4
Compare Source
v3.9.1
Compare Source
What's Changed
Full Changelog: actions/setup-node@v3...v3.9.1
v3.9.0
Compare Source
What's Changed
In scope of this release we updated actions/cache package to ensure continued support and compatibility, as older versions of the package are now deprecated. For more information please refer to the toolkit/cache.
Full Changelog: actions/setup-node@v3...v3.9.0
v3.8.2
Compare Source
What's Changed
Full Changelog: actions/setup-node@v3...v3.8.2
v3.8.1
Compare Source
What's Changed
In scope of this release, the filter was removed within the cache-save step by @dmitry-shibanov in #831. It is filtered and checked in the toolkit/cache library.
Full Changelog: actions/setup-node@v3...v3.8.1
v3.8.0
Compare Source
What's Changed
Bug fixes:
Feature implementations:
Documentation changes:
Update dependencies:
New Contributors
Full Changelog: actions/setup-node@v3...v3.8.0
v3.7.0
Compare Source
What's Changed
In scope of this release we added a logic to save an additional cache path for yarn 3 (related pull request and feature request). Moreover, we added functionality to use all the sub directories derived from cache-dependency-path input and add detect all dependencies directories to cache (related pull request and feature request).
Besides, we made such changes as:
New Contributors
Full Changelog: actions/setup-node@v3...v3.7.0
v3.6.0: Add Support for Nightly, Canary and RC builds for Node.js
Compare Source
In scope of this release we added support to download nightly, rc (#611) and canary (#619) Node.js distributions.
For nightly versions:
For canary versions:
For rc versions:
Note: For more examples please refer to documentation.
Besides, we added the following changes as:
v3.5.1: Update @actions/core and Print Node, Npm, Yarn versions
Compare Source
In scope of this release we updated actions/core to 1.10.0. Moreover, we added logic to print Nodejs, Npm, Yarn versions after installation.
v3.5.0: Add support for engines.node and Volta
Compare Source
In scope of this release we add support for engines.node. The action will be able to grab the version form package.json#engines.node. #485. Moreover, we added support for Volta
Besides, we updated @actions/core to 1.9.1 and @actions/cache to 3.0.4
v3.4.1: Fix pnpm output and node-version output issues
Compare Source
In scope of this release we fixed bugs related to the pnpm 7.5.1 output issue from pnpm store path #545. Moreover we fixed the issue with falling on node-version output #540.
v3.4.0: Add support for asdf format and update actions/cache version to 3.0.0
Compare Source
In scope of this release we updated actions/cache package as the new version contains fixes for caching error handling. Moreover, we added support for asdf format as Node.js version file #373. Besides, we introduced new output node-version and added npm-shrinkwrap.json to dependency file patterns: #439
v3.3.0: Add support for lts/-n aliases
Compare Source
In scope of this release we added support for lts/-n aliases, improve logic for current, latest and node aliases to handle them from toolcache, update ncc package.
Support of lts/-n aliases
Minor improvements
v3.2.0: Add current, node, latest aliases
Compare Source
In scope of this release we added new aliases to install the latest Node.js version. #483
v3.1.1: Update actions/cache version to 2.0.2
Compare Source
In scope of this release we updated actions/cache package as the new version contains fixes related to GHES 3.5 (#460)
v3.1.0: Add caching support on GHES 3.5
Compare Source
In scope of this release we added support for caching from GHES 3.5 and fixed download issue for files > 2GB during restore. Besides, we updated actions/cache dependency to 2.0.0 version.
v3.0.0
Compare Source
In scope of this release we changed version of the runtime Node.js for the setup-node action and updated package-lock.json file to v2.
Breaking Changes
v3
Compare Source
v2.5.2: Update @actions/core for v2
Compare Source
In scope of this release we updated actions/core to 1.10.0 and actions/tool-cache to 1.7.2 for v2: #713
v2.5.1: Fix logic of error handling for npm warning and uncaught exception
Compare Source
In scope of this release we fix logic of error handling related to caching (#358) and (#359).
In the previous behaviour we relied on stderr output to throw error. The warning messages from package managers can be written to the stderr's output. For now the action will throw an error only if exit code differs from zero. Besides, we add logic to сatch and log unhandled exceptions.
v2.5.0: Adding Node.js version file support
Compare Source
In scope of this release we add the node-version-file input and update actions/cache dependency to the latest version.
Adding Node.js version file support
The new input (node-version-file) provides functionality to specify the path to the file containing Node.js's version with such behaviour:
Update actions/cache dependency to 1.0.8 version.
We updated actions/cache dependency to the latest version (1.0.8). For more information please refer to the toolkit/cache.
v2.4.1: Add "cache-hit" output
Compare Source
This release introduces a new output: cache-hit (#327).
The cache-hit output contains boolean value indicating that an exact match was found for the key. It shows that the action uses already existing cache or not. The output is available only if cache is enabled.
v2.4.0: Support caching for mono repos and repositories with complex structure
Compare Source
This release introduces dependency caching support for mono repos and repositories with complex structure (#305).
By default, the action searches for the dependency file (package-lock.json or yarn.lock) in the repository root. Use the cache-dependency-path input for cases when multiple dependency files are used, or they are located in different subdirectories. This input supports wildcards or a list of file names for caching multiple dependencies.
Yaml example:
For more examples of using cache-dependency-path input, see the Advanced usage guide.
v2.3.2: Revert temporary fix
Compare Source
We had to disable pre-cached Node.js usage in the previous version due to the broken image cache. Now cache is fixed, so we can safely enable its usage again.
Thank you for understanding.
v2.3.1: Temporary maintenance fix.
Compare Source
Temporarily disabled usage of pre-cached Node.js.
v2.3.0: Support caching pnpm dependencies
Compare Source
This release introduces dependency caching support for the pnpm package manager (#278).
Caching pnpm dependencies:
NOTE: pnpm caching support requires pnpm version >= 6.10.0
v2.2.0: Support caching dependencies and LTS aliases
Compare Source
This release brings two major features:
Supported version syntax
The node-version input supports the following syntax:
major versions: 12, 14, 16
more specific versions: 10.15, 14.2.0, 16.3.0
nvm LTS syntax: lts/erbium, lts/fermium, lts/*
Caching dependencies
The action has a built-in functionality for caching and restoring npm/yarn dependencies. Supported package managers are npm, yarn. The cache input is optional, and caching is turned off by default.
Caching npm dependencies:
Caching yarn dependencies:
Yarn caching handles both yarn versions: 1 or 2.
v2.1.5: Release
Compare Source
Improve error and warning line number handling (problem matcher regex)
v2.1.4
Compare Source
The first stable release of actions/setup-node V2
v2.1.3: (beta)
Compare Source
Configuration
📅 Schedule: (UTC)
🚦 Automerge: Disabled by config. Please merge this manually once you are satisfied.
♻ Rebasing: Whenever PR becomes conflicted, or you tick the rebase/retry checkbox.
🔕 Ignore: Close this PR and you won't be reminded about this update again.
This PR was generated by Mend Renovate. View the repository job log.