An open API service indexing awesome lists of open source software.

https://github.com/stackb/rules_proto

Bazel build rules for protobuf / gRPC (now with gazelle)
https://github.com/stackb/rules_proto

bazel bazel-rules gazelle grpc protobuf routeguide

Last synced: 2 months ago
JSON representation

Bazel build rules for protobuf / gRPC (now with gazelle)

Awesome Lists containing this project

README

          

# `rules_proto (v4)`

![build-status](https://github.com/stackb/rules_proto/actions/workflows/ci.yaml/badge.svg)
[![Go Reference](https://pkg.go.dev/badge/github.com/stackb/rules_proto.svg)](https://pkg.go.dev/github.com/stackb/rules_proto)

Bazel starlark rules for building protocol buffers +/- gRPC :sparkles:.








bazel
gazelle
protobuf
grpc

`@build_stack_rules_proto` provides:

1. Rules for driving the `protoc` tool within a bazel workspace.
2. A [gazelle](https://github.com/bazelbuild/bazel-gazelle/) extension that
generates rules based on the content of your `.proto` files.
3. Example setups for a variety of languages.

## `MODULE.bazel`

```py
bazel_dep(name = "build_stack_rules_proto", version = "4.x.x")
```

> NOTE: `build_stack_rules_proto` is still in the submission process to the bcr.
> Until merged, a git_override or other override is needed to consume this
> repository.

See for latest version.

> NOTE: Version 4.x.x no longer supports `WORKSPACE`, please use the latest
> 3.x.x release for workspace compatibility.

## Docs

| Description | Link |
|-------------------------------------------|-----------------------------------------|
| Documentation about the core ruleset | [CORE_RULES.md](/docs/CORE_RULES.md) |
| Available Toolchains | [TOOLCHAINS.md](/docs/TOOLCHAINS.md) |
| Guide to setting up the gazelle extension | [GAZELLE.md](/docs/GAZELLE.md) |
| Writing custom gazelle logic | [STARLARK.md](/docs/STARLARK.md) |
| Examples | [example/README.md](/example/README.md) |
| Preconfigured plugins | [PLUGINS.md](/docs/PLUGINS.md) |
| Preconfigured rules | [RULES.md](/docs/RULES.md) |
| A history of this repository | [HISTORY.md](/docs/HISTORY.md) |
| Developer Guide | [DEVELOPMENT.md](/docs/DEVELOPMENT.md) |