Using Buf

Important message

For this section, you are going to need Buf CLI. You can find how to install it here: https://buf.build/docs/installation.

The next tool that is important to know is Buf (https://buf.build/). This is mainly a CLI tool that deals with your proto files in some way. It can build them, lint them, format them, check for breaking changes, and so on. It is very interesting because it can help you with every step of the CI/CD pipeline.

Let’s see an example of how to use the CLI. Let’s assume that we have a similar project to what we had in the previous section:

.
├─ go.mod
├─ main.go
└─ proto
   ├─ test.proto
   └─ v1
      └─ test.proto

Now, at the root of the proto files (the proto directory), run the following command:

$ buf mod init

This should create a buf.yaml file in the proto directory...