https://github.com/tilt-dev/local_resource_example
https://github.com/tilt-dev/local_resource_example
Last synced: 8 months ago
JSON representation
- Host: GitHub
- URL: https://github.com/tilt-dev/local_resource_example
- Owner: tilt-dev
- Created: 2019-09-23T21:52:09.000Z (almost 7 years ago)
- Default Branch: master
- Last Pushed: 2023-02-24T23:06:53.000Z (over 3 years ago)
- Last Synced: 2025-04-23T23:37:28.589Z (about 1 year ago)
- Language: Go
- Size: 20.5 KB
- Stars: 3
- Watchers: 3
- Forks: 1
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# What's in this repo?
This repo is a simple client+server that exchange greetings. They communicate via [protocol buffers](https://developers.google.com/protocol-buffers)
generated from `helloworld.proto`.
The purpose of this repo is to show off [our new `local_resource` functionality](https://docs.tilt.dev/local_resource.html). In this Tiltfile, we call:
```python
local_resource('proto', cmd='go generate ./greeter_server', deps=['helloworld/helloworld.proto'])
```
This call tells Tilt: "when `helloworld/helloworld.proto` changes, run `go generate ./greeter_server`". That is,
Tilt generates your protobufs for you automatically, only when the relevant file changes. Even better, you can
see output and status of this command in the UI along with the rest of your resources.
## Give it a shot!
Pull down this repo, `tilt up`, and once everything's up, make a change to `helloworld.proto`--say, add a field to
the `HelloRequest`. Your Local Resource will pick up this change and regenerate `helloworld.pb.go`, and the client and
server will both pick up this file change via Live Update and propagate it to their running containers. ⚡️
### Dependencies
1. Install [the Go toolchain](https://golang.org/doc/install)
2. Install [protobuf compiler](https://github.com/google/protobuf/blob/master/README.md#protocol-compiler-installation)
3. Install the protoc Go plugin
```
$ go get -u github.com/golang/protobuf/protoc-gen-go
```
4. [Install Tilt](https://docs.tilt.dev/install.html)
5. `tilt up`