Skip to content

Commit

Permalink
add README (#2)
Browse files Browse the repository at this point in the history
  • Loading branch information
tsawada authored Nov 3, 2022
1 parent 708b175 commit eec5cff
Showing 1 changed file with 24 additions and 0 deletions.
24 changes: 24 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,24 @@
# bazel-github-actions-cache

bazel-github-actions-cache is a Bazel Remote Caching server that uses Github Action's undocumented cache API as backend.

Its goal is to utilize Actions Cache more efficiently, both in terms of speed and space, compared to [actions/cache](https://github.com/actions/cache).

## Usage

Add following step in your actions yaml file.
```
- name: bazel-github-actions-cache
uses: tsawada/bazel-github-actions-cache@v0
```

Add following flag to Bazel.
```
--remote_cache=http://localhost:3055
```

## TODO

* Proper error handling
* Compression
* gRPC interface

0 comments on commit eec5cff

Please sign in to comment.