Skip to content

Commit fb1c18e

Browse files
author
Florin Stan
committed
Add README.md with Protobuf definitions and usage instructions for exileapi project
1 parent f00766a commit fb1c18e

File tree

1 file changed

+50
-0
lines changed

1 file changed

+50
-0
lines changed

README.md

Lines changed: 50 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,50 @@
1+
# exileapi Protobuf Definitions
2+
3+
This repository contains the Protobuf definitions for the exileapi project.
4+
5+
## Buf Schema Registry
6+
7+
These definitions are managed using [Buf](https://buf.build/). They are automatically linted, checked for breaking changes, and pushed to the [Buf Schema Registry (BSR)](https://buf.build/tcn/exileapi) via GitHub Actions.
8+
9+
The module name is `buf.build/tcn/exileapi`.
10+
11+
## Usage
12+
13+
You can depend on these Protobuf definitions in your own projects using Buf. Add the following dependency to your `buf.yaml` file:
14+
15+
```yaml
16+
version: v2
17+
deps:
18+
- buf.build/tcn/exileapi
19+
```
20+
21+
Then, run `buf mod update` to fetch the dependency.
22+
23+
## Development
24+
25+
### Linting
26+
27+
To lint the definitions locally:
28+
```bash
29+
buf lint
30+
```
31+
32+
### Breaking Change Detection
33+
34+
To check for breaking changes against the `master` branch on the BSR:
35+
```bash
36+
buf breaking --against buf.build/tcn/exileapi:master
37+
```
38+
39+
## GitHub Actions
40+
41+
A GitHub Actions workflow (`.github/workflows/buf-push.yaml`) is configured to automatically:
42+
43+
1. **Lint & Check Breaking Changes:** On pushes to the `master` branch.
44+
2. **Push to BSR:** On pushes to the `master` branch and when tags matching `v*` are created.
45+
46+
This ensures that the definitions in the BSR are always up-to-date with the `master` branch and tagged releases.
47+
48+
## Contributing
49+
50+
[Add contribution guidelines here if applicable]

0 commit comments

Comments
 (0)