go-tool-cache

module
v0.0.0-...-ef6c7b1 Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: Apr 25, 2023 License: BSD-3-Clause

README

go-tool-cache

Like Go's built-in build/test caching but wish it weren't purely stored on local disk in the $GOCACHE directory?

Want to share your cache over the network between your various machines, coworkers, and CI runs without all that GitHub actions/caches tarring and untarring?

Along with a modification to Go's cmd/go tool (open proposal), this repo lets you write custom GOCACHE implementations to handle the cache however you'd like.

Status

Currently you need to build your own Go toolchain to use this. As of 2023-04-24 it's still an open proposal & work in progress.

Using

First, build your cache child process. For example,

$ go install github.com/bradfitz/go-tool-cache/cmd/go-cacher

Then tell Go to use it:

$ GOCACHEPROG=$HOME/go/bin/go-cacher go install std

See some stats:

$ GOCACHEPROG="$HOME/go/bin/go-cacher --verbose" go install std
Defaulting to cache dir /home/bradfitz/.cache/go-cacher ...
cacher: closing; 548 gets (0 hits, 548 misses, 0 errors); 1090 puts (0 errors)

Run it again and watch the hit rate go up:

$ GOCACHEPROG="$HOME/go/bin/go-cacher --verbose" go install std
Defaulting to cache dir /home/bradfitz/.cache/go-cacher ...
cacher: closing; 808 gets (808 hits, 0 misses, 0 errors); 0 puts (0 errors)

Directories

Path Synopsis
Package cacheproc implements the mechanics of talking to cmd/go's GOCACHE protocol so you can write a caching child process at a higher level.
Package cacheproc implements the mechanics of talking to cmd/go's GOCACHE protocol so you can write a caching child process at a higher level.
cmd
go-cacher
The go-cacher binary is a cacher helper program that cmd/go can use.
The go-cacher binary is a cacher helper program that cmd/go can use.
go-cacher-server
The go-cacher-server is an HTTP server daemon that go-cacher can hit.
The go-cacher-server is an HTTP server daemon that go-cacher can hit.
Package wire contains the JSON types that cmd/go uses to communicate with child processes implementing the cache interface.
Package wire contains the JSON types that cmd/go uses to communicate with child processes implementing the cache interface.

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL