Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/stormcat24/protodep
Collect necessary .proto files (Protocol Buffers IDL) and manage dependencies
https://github.com/stormcat24/protodep
cli dependencies dependency-manager grpc idl microservices protocol-buffers toml tool vendoring
Last synced: 5 days ago
JSON representation
Collect necessary .proto files (Protocol Buffers IDL) and manage dependencies
- Host: GitHub
- URL: https://github.com/stormcat24/protodep
- Owner: stormcat24
- License: apache-2.0
- Created: 2017-04-18T14:32:08.000Z (almost 8 years ago)
- Default Branch: master
- Last Pushed: 2024-01-26T12:26:52.000Z (12 months ago)
- Last Synced: 2025-01-11T00:07:27.232Z (12 days ago)
- Topics: cli, dependencies, dependency-manager, grpc, idl, microservices, protocol-buffers, toml, tool, vendoring
- Language: Go
- Homepage:
- Size: 372 KB
- Stars: 307
- Watchers: 8
- Forks: 58
- Open Issues: 16
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
protodep
=======
[](https://golang.org/)
[](https://github.com/stormcat24/protodep/issues?state=open)
[](LICENSE)
[](https://godoc.org/github.com/stormcat24/protodep)
[](go.mod)
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 install
```bash
$ go install -v github.com/stormcat24/[email protected]
```
### from binary
Support as follows:
* protodep_darwin_amd64.tar.gz
* protodep_darwin_arm64.tar.gz
* protodep_linux_386.tar.gz
* protodep_linux_amd64.tar.gz
* protodep_linux_arm.tar.gz
* protodep_linux_arm64.tar.gz
```bash
$ wget https://github.com/stormcat24/protodep/releases/download/0.1.4/protodep_darwin_amd64.tar.gz
$ tar -xf protodep_darwin_amd64.tar.gz
$ mv protodep /usr/local/bin/
```
## Usage
### protodep.toml
Proto dependency management is defined in `protodep.toml`.
```Ruby
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"
# blacklist by "ignores" attribute
[[dependencies]]
target = "github.com/kubernetes/helm/_proto/hapi"
branch = "master"
path = "helm/hapi"
ignores = ["./release", "./rudder", "./services", "./version"]
# whitelist by "includes" attribute
[[dependencies]]
target = "github.com/protodep/catalog/hierarchy"
branch = "main"
includes = [
"/protodep/hierarchy/service.proto",
"**/fuga/**",
]
protocol = "https"
```
### protodep up
In same directory, execute this command.
```bash
$ protodep up
```
If succeeded, `protodep.lock` is generated.
### protodep up -f (force update)
Even if protodep.lock exists, you can force update dependenies.
```bash
$ protodep up -f
```
### [Attention] Changes from 0.1.0
From protodep 0.1.0 supports ssh-agent, and this is the default.
In other words, in order to operate protodep without options as before, it is necessary to set with ssh-add.
As the follows:
```bash
$ ssh-add ~/.ssh/id_rsa
$ protodep up
```
### Getting via HTTPS
If you want to get it via HTTPS, do as follows.
```bash
$ protodep up --use-https
```
And also, if Basic authentication is required, do as follows.
If you have 2FA enabled, specify the Personal Access Token as the password.
```bash
$ protodep up --use-https \
--basic-auth-username=your-github-username \
--basic-auth-password=your-github-password
```
### License
Apache License 2.0, see [LICENSE](https://github.com/stormcat24/protodep/blob/master/LICENSE).