README.md

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:
            [email protected] [email protected] [email protected] [email protected]
            [email protected]
          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:

• go
• go-grpc
• python_betterproto
• ts-proto
• grpc-java

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