balaji30/buf-example

Example repository that uses Buf.

Buf Example

This is a simple example of Buf usage that:

• Installs buf from GitHub Releases.
• Runs linting and breaking change detection.

CI is set up for:

• Travis CI
• CircleCI
• GitHub Actions

The default make target is make local, which compares against the head of your local git master branch for breaking change detection.

The make targets make https and make ssh compare against the head of the remote git master branch, due to Travis and CircleCI not cloning any branch except for that under test. In this example, we use https for Travis, and both https and ssh for CircleCI, but you only need to choose one of https and ssh.

For GitHub Actions, you can use make local with a trick that clones the branch you want first, and then creates a local head for it. See ci.yaml for an example.

See buf.build for documentation.