https://github.com/tcncloud/exileapi
https://github.com/tcncloud/exileapi
Last synced: 4 months ago
JSON representation
- Host: GitHub
- URL: https://github.com/tcncloud/exileapi
- Owner: tcncloud
- Created: 2025-04-30T04:24:16.000Z (about 1 year ago)
- Default Branch: master
- Last Pushed: 2025-12-19T21:05:31.000Z (6 months ago)
- Last Synced: 2025-12-22T09:33:11.189Z (6 months ago)
- Size: 160 KB
- Stars: 0
- Watchers: 3
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# exileapi Protobuf Definitions
This repository contains the Protobuf definitions for the exileapi project.
## Buf Schema Registry
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.
The module name is `buf.build/tcn/exileapi`.
## Usage
You can depend on these Protobuf definitions in your own projects using Buf. Add the following dependency to your `buf.yaml` file:
```yaml
version: v2
deps:
- buf.build/tcn/exileapi
```
Then, run `buf mod update` to fetch the dependency.
## Development
### Linting
To lint the definitions locally:
```bash
buf lint
```
### Breaking Change Detection
To check for breaking changes against the `master` branch on the BSR:
```bash
buf breaking --against buf.build/tcn/exileapi:master
```
## GitHub Actions
A GitHub Actions workflow (`.github/workflows/buf-push.yaml`) is configured to automatically:
1. **Lint & Check Breaking Changes:** On pushes to the `master` branch.
2. **Push to BSR:** On pushes to the `master` branch and when tags matching `v*` are created.
This ensures that the definitions in the BSR are always up-to-date with the `master` branch and tagged releases.
## Contributing
[Add contribution guidelines here if applicable]