No description, website, or topics provided.
Branch: master
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
.ci
.gitignore
README.md
device_info_service.proto
meta_service.proto
prototool.yaml
weather_service.proto

README.md

zephyrus-schemas

This repository versions the Protocol Buffer message schemas used by the Zephyrus gRPC server and clients.

Workflow

Initialization

To depend on zephyrus-schemas in a new project at vendor directory schemas/:

$ git submodule add git@git.kevinlin.info:personal/zephyrus-schemas.git schemas/
$ git commit -m "zephyrus-schemas dependency"

Build processes in the parent repository that depend on these schemas should ensure to initialize the submodule beforehand.

# These commands are idempotent
$ git submodule init
$ git submodule update

Updating

To update the schemas dependency commit in a parent project to $SCHEMAS_COMMIT_SHA, assuming the submodule is vendored to schemas/:

$ git -C schemas/ fetch
$ git -C schemas/ checkout $SCHEMAS_COMMIT_SHA
$ git add schemas/
$ git commit -m "Bump zephyrus-schemas to $SCHEMAS_COMMIT_SHA"

Development

All protobuf files should pass lint, compilation, and formatting.

$ go get github.com/uber/prototool/cmd/prototool
$ prototool lint
$ prototool compile
$ prototool format -d