Go Makefile Shell
Switch branches/tags
Clone or download
stormcat24 Merge pull request #24 from stormcat24/feature/update-readme
add description about path and ignores
Latest commit 1a4a015 Feb 21, 2018

README.md

protodep

Circle CI Language issues License: MIT GoDoc

Dependency tool for Protocol Buffers IDL file (.proto) vendoring tool.

Motivation

In building Microservices architecture, gRPC with Protocol Buffers is effective. When using gRPC, your application will depend on many remote services.

If you manage proto files in a git repository, what will you do? Most remote services are managed by git and they will be versioned. We need to control which dependency service version that application uses.

Install

go get

$ go get github.com/stormcat24/protodep

from binary

Support as follows:

  • protodep_darwin_amd64.tar.gz
  • protodep_linux_386.tar.gz
  • protodep_linux_amd64.tar.gz
  • protodep_linux_arm.tar.gz
  • protodep_linux_arm64.tar.gz
$ wget https://github.com/stormcat24/protodep/releases/download/0.0.1/protodep_darwin_amd64.tar.gz
$ cp protodep /usr/local/bin/

Usage

protodep.toml

Proto dependency management is defined in protodep.toml.

proto_outdir = "./proto"

[[dependencies]]
  target = "github.com/stormcat24/protodep/protobuf"
  branch = "master"

[[dependencies]]
  target = "github.com/grpc-ecosystem/grpc-gateway/examples/examplepb"
  revision = "v1.2.2"
  path = "grpc-gateway/examplepb"

[[dependencies]]
  target = "github.com/kubernetes/helm/_proto/hapi"
  branch = "master"
  path = "helm/hapi"
  ignores = ["./release", "./rudder", "./services", "./version"]

protodep up

In same directory, execute this command.

$ protodep up

If succeeded, protodep.lock is generated.

protodep up -f (force update)

Even if protodep.lock exists, you can force update dependenies.

$ protodep up -f

License

See LICENSE.

Copyright © stromcat24. All Rights Reserved.