search

bitrise-steplib / bitrise-step-restore-npm-cache

0 stars 1 forks source link
bitrise bitrise-step ci production-code

readme

Restore NPM Cache

Step changelog

Restores cached node_modules dependencies, used by NPM and Yarn. This Step needs to be used in combination with Save NPM Cache.

Description Restores cached node_modules dependencies. This Step needs to be used in combination with **Save NPM Cache**. This Step is based on [key-based caching](https://devcenter.bitrise.io/en/builds/caching/key-based-caching.html) and sets up the cache key and path automatically for NPM dependencies. If you'd like to change the cache keys, you might want to use the generic [Restore cache](https://github.com/bitrise-steplib/bitrise-step-restore-cache) Step instead. Note: NPM and Yarn package managers are both supported. #### Related steps [Save NPM cache](https://github.com/bitrise-steplib/bitrise-step-save-npm-cache/) [Restore cache](https://github.com/bitrise-steplib/bitrise-step-restore-cache/)

🧩 Get started

Add this step directly to your workflow in the Bitrise Workflow Editor.

You can also run this step directly with Bitrise CLI.

Minimal example

steps:
- restore-npm-cache@1: {}
- npm@1:
    inputs:
    - command: install
- save-npm-cache@1: {}

Check out Workflow Recipes for other caching examples!

⚙️ Configuration

Inputs | Key | Description | Flags | Default | | --- | --- | --- | --- | | `verbose` | Enable logging additional information for troubleshooting | required | `false` |
Outputs | Environment Variable | Description | | --- | --- | | `BITRISE_CACHE_HIT` | Indicates if a cache entry was restored. Possible values: - `exact`: Exact cache hit for the first requested cache key - `partial`: Cache hit for a key other than the first - `false` No cache hit, nothing was restored |

🙋 Contributing

We welcome pull requests and issues against this repository.

For pull requests, work on your changes in a forked repository and use the Bitrise CLI to run step tests locally.

Note: this step's end-to-end tests (defined in e2e/bitrise.yml) are working with secrets which are intentionally not stored in this repo. External contributors won't be able to run those tests. Don't worry, if you open a PR with your contribution, we will help with running tests and make sure that they pass.

Learn more about developing steps: