Skip to content

Commit

Permalink
README: update README
Browse files Browse the repository at this point in the history
  • Loading branch information
adityamaru committed Dec 16, 2024
1 parent 1e9b1c3 commit c10e7ce
Showing 1 changed file with 6 additions and 4 deletions.
10 changes: 6 additions & 4 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,13 +1,15 @@
# Blacksmith Sticky Disk Action

A GitHub Action that helps persist state written to disk across jobs. Each sticky disk is backed by local NVMe storage and is formmatted as an ext4 filesystem.
A GitHub Action that helps persist state written to disk across jobs. Each sticky disk is hot-loaded into the runner and mounted at the specified path.
The sticky disk is formatted as an ext4 filesystem.

Some common use cases of this action include:

- Caching build artifacts such as NPM packages (egs: node_modules, yarn.lock, etc)
- Caching Bazel build artifacts
- Caching Bazel artifacts that are written to the disk and repository cache (use `useblacksmith/setup-bazel@v2`[https://github.com/useblacksmith/setup-bazel])

Coming soon:

- Caching docker pull and extraction to minimize container startup times
- Caching large repositories to make checking out code instantaneous

Expand All @@ -19,10 +21,10 @@ jobs:
runs-on: blacksmith
steps:
- name: Cache NPM packages
uses: useblacksmith/stickydisk-action@master
uses: useblacksmith/stickydisk@v1
with:
key: ${{ github.repository }}-npm-cache
path: ~/.node_modules
```
Each sticky disk is uniquely identified by a key. The sticky disk will be mounted at the specified path. Once the job completes, the sticky disk will be unmounted and committed for future invocations. At the moment, customers can use up to 5 sticky disks in a single GitHub Action job.
Each sticky disk is uniquely identified by a key. The sticky disk will be mounted at the specified path. Once the job completes, the sticky disk will be unmounted and committed for future invocations. At the moment, customers can use up to 10 sticky disks in a single GitHub Action job.

0 comments on commit c10e7ce

Please sign in to comment.