Enable multi-layer cache and shortcut commands in any workflows.
Manage multiple cache targets in one step. Use either the built-in cache configs for npm, yarn, and pip, or write your own. Create a bash command library to easily reduce redudencies across workflows. Most useful for building webapps that require multi-stage building processes.
This is your all-in-one action for everything related to setting up dependencies with cache.
.github/workflows/caches.js
.github/workflows/bashlib.sh
Following workflow sets up dependencies for a typical Python web app with both ~/.pip
and ~/.npm
cache configured in one simple step:
jobs: build_and_test: runs-on: ubuntu-latest steps: - name: Checkout code uses: actions/checkout@v2 - name: Install dependencies uses: ktmud/cached-dependencies@v1 with: run: | npm-install npm run build pip-install python ./bin/manager.py fill_test_data
Here we used predefined npm-install
and pip-install
commands to install dependencies with correponding caches.
You may also replace npm-install
with yarn-install
to install npm pacakges with yarn.lock
.
- name: Install dependencies uses: ktmud/cached-dependencies@v1 with: run: | yarn-install yarn build pip-install python ./bin/manager.py fill_test_data
See below for more details.
Under the hood, we use @actions/cache to manage cache storage. But instead of defining only one cache at a time and specify them in workflow YAMLs, you manage all caches in a spearate JS file: .github/workflows/caches.js
.
Here is the default configuration for Linux:
module.exports = { pip: { path: [`${process.env.HOME}/.cache/pip`], hashFiles: ['requirements*.txt'], keyPrefix: 'pip-', restoreKeys: 'pip-', }, npm: { path: [`${HOME}/.npm`], hashFiles: [ `package-lock.json`, `*/*/package-lock.json`, `!node_modules/*/package-lock.json`, ], }, yarn: { path: [`${HOME}/.npm`], // */* is for supporting lerna monorepo with depth=2 hashFiles: [`yarn.lock`, `*/*/yarn.lock`, `!node_modules/*/yarn.lock`], }, }
In which hashFiles
and keyPrefix
will be used to compute the primary cache key used in @actions/cache. keyPrefix
will default to ${cacheName}-
and restoreKeys
will default to keyPrefix
if not specified.
It is recommended to always use absolute paths in these configs so you can share them across different worflows more easily (in case you the action is called from different working directories).
With the predefined cache-store
and cache-save
bash commands, you have full flexibility on when to restore and save cache:
steps: - uses: actions/checkout@v2 - uses: ktmud/cached-dependencies@v1 with: run: | cache-restore npm npm install cache-save npm cache-restore pip pip install -r requirements.txt cache-save pip
All predefined shortcut commands can be found here. You can also customize them or add new ones in .github/workflows/bashlib.sh
.
For example, if you want to install additional packages for before saving pip
cache, simply add this to the bashlib.sh
file:
# override the default `pip-install` command pip-install() { cd $GITHUB_WORKSPACE cache-restore pip echo "::group::pip install" pip install -r requirements.txt # prod requirements pip install -r requirements-dev.txt # dev requirements pip install -e ".[postgres,mysql]" # current pacakge with some extras echo "::endgroup::" cache-save pip }
When run
is not provided:
jobs: name: Build steps: - name: Install dependencies uses: ktmud/cached-depdencies@v1
You must provide a default-setup-command
in the bashlib. For example,
default-setup-command() { pip-install & npm-install }
This will start installing pip and npm dependencies at the same time.
Both the two config files, .github/workflows/bashlib.sh
and .github/workflows/caches.js
, can be placed in other locations:
- uses: ktmud/cached-dependencies@v1 with: caches: ${{ github.workspace }}/.github/configs/caches.js bashlib: ${{ github.workspace }}/.github/configs/bashlib.sh
When parallel
is set to true
, the run
input will be split into an array of commands and passed to Promise.all(...)
to execute in parallel. For example,
- uses: ktmud/cached-dependencies@v1 with: parallel: true run: | pip-install npm-install
is equivalent to
- uses: ktmud/cached-dependencies@v1 with: run: | pip-install & npm-install
If one or more of your commands must spread across multiple lines, you can add a new line between the parallel commands. Each command within a parallel group will still run sequentially.
- uses: ktmud/cached-dependencies@v1 with: run: | cache-restore pip pip install requirements*.txt # additional pip packages pip install package1 package2 pacakge2 cache-save pip npm-install cache-restore cypress cd cypress/ && npm install cache-save cypress
This project is released under the MIT License.