Evolution of https://github.com/stormcat24/protodep, which unfortunately has not been updated by the author for a long time
- Added support for .netrc file
- Added support for local proto files import
- Added support for gitlab subgroups
-
protodep.lockfile removed -
-f,--forceoption removed
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.
go install -v github.com/n-r-w/protodep@latestProto 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"
# 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"
# gitlab subgroups
# repository: gitlab.company.org/core/product/backend/service1
# subgroup: backend/service
[[dependencies]]
target = "gitlab.company.org/core/product/backend/service1/api/protos"
subgroup = "backend/service1"
revision = "v1.0.0"
path = "service1"
username_env = "GITLAB_USERNAME" # user environment variable for HTTP Basic Authentication
password_env = "GITLAB_PASSWORD" # token/password environment variable for HTTP Basic Authentication
# import from local folder
[[dependencies]]
local_folder = "./api/broker"
path = "proto/broker"In same directory, execute this command.
protodep upIf you want to get it via HTTPS, do as follows.
protodep up --use-httpsAnd also, if Basic authentication is required, do as follows. If you have 2FA enabled, specify the Personal Access Token as the password.
$ protodep up --use-https \
--basic-auth-username=your-github-username \
--basic-auth-password=your-github-passwordYou can also set the username and password as environment variables and set them in the protodep.toml file for each dependency.
[[dependencies]]
target = "github.com/your-org/your-repo"
branch = "master"
username_env = "GITHUB_USERNAME"
password_env = "GITHUB_PASSWORD"Another way is to use the .netrc file in your home directory. Set the username and password in the .netrc as follows.
machine github.com
login your-github-username
password your-github-tokenApache License 2.0, see LICENSE.