Skip to content

A GitHub action to build and lint protobuf using buildbuf

License

Notifications You must be signed in to change notification settings

ory/build-buf-action

Use this GitHub action with your project
Add this Action to an existing workflow or create a new one
View on Marketplace

Build Buf GitHub Action

A GitHub action that provides buf.

Usage

name: Generate and Lint buf

on:
  push:
    branches:
      - "*"
  workflow_dispatch:

jobs:
  lint-build:
    name: buf check lint
    runs-on: ubuntu-latest
    steps:
      - uses: actions/checkout@v2
      - uses: ory/build-buf-action@v0
        with:
          bufVersion: v0.31.1
          bufArgs: check lint --config buf/api/buf.yaml
      - uses: ory/build-buf-action@v0
        with:
          bufVersion: v0.31.1
          protocPlugins:
            go@v1.25.0 go-grpc@v1.0.1 python_betterproto@2.0.0b2 ts-proto@1.39.0
            grpc-java@1.34.0
          bufArgs:
            generate --config buf/api/buf.yaml --template buf/api/buf.gen.yaml
# Don't forget to commit and push after this step

Plugins

buf requires you to install the protoc plugins for the languages you want to generate. Currently, the following plugins are available in the action:

Please open a PR to add install scripts for any missing plugin.