null-protos

here lie .proto files used across null for gRPC communication.

development

init

using git submodules is, in my opinion, the cleanest way to add these to a project.

to add a ./proto folder with the submodule in a new project, run:

git submodule add -b main git@github.com:xhos/null-protos.git proto
git commit -m "Add null-protos as submodule at proto/"

then to generate code you would add a buf.gen.yaml that looks something like this:

version: v2

inputs:
  - directory: proto # note that this points to the submodule

plugins:
  - local: protoc-gen-go
    out: gen/go
    opt:
      - paths=source_relative

  - local: protoc-gen-go-grpc
    out: gen/go
    opt:
      - paths=source_relative
      - require_unimplemented_servers=false

buf generate

update

to update the submodule to the latest version, run:

git -C proto fetch origin
git -C proto checkout main
git -C proto pull --ff-only
git add proto
git commit -m "⬆️ bump proto files"
git push

how to clone a repo that uses this submodule

git clone --recurse-submodules <repo-url>

if you forgot to use --recurse-submodules, you can run:

git submodule update --init --recursive