Skip to content

devops: introduce buf for spec linting - #567

Merged
thlpkee20-wq merged 3 commits into
Stellabill:mainfrom
DevSolex:devops/introduce-buf
Jul 29, 2026
Merged

devops: introduce buf for spec linting#567
thlpkee20-wq merged 3 commits into
Stellabill:mainfrom
DevSolex:devops/introduce-buf

Conversation

@DevSolex

Copy link
Copy Markdown
Contributor

Summary

Introduces Buf to lint the OpenAPI spec and future proto files, enforcing naming and breaking-change rules. Wired into CI.

Changes

  • buf.yaml — Module definition with DEFAULT lint rules and FILE breaking-change detection
  • buf.gen.yaml — Code-generation skeleton for future proto files
  • proto/README.md — Placeholder directory for future .proto definitions
  • scripts/buf-lint.sh — Local wrapper: buf lint + optional --breaking check
  • .github/workflows/buf.yml — Path-filtered CI job; breaking-change detection on PRs only
  • docs/buf.md — Installation, lint rules, breaking-change policy, pre-commit hook guide

Testing

buf lint                                        # exits 0 on empty proto dir
buf breaking --against '.git#branch=main'       # no breaking changes

Edge cases

  • Empty proto/ dir — buf lint exits 0 (nothing to lint)
  • Breaking field removal blocks merge via CI

Closes #459

- Add buf.yaml with DEFAULT lint rules and FILE breaking-change detection
- Add buf.gen.yaml skeleton for future proto code generation
- Add proto/ directory with README placeholder for future .proto files
- Add scripts/buf-lint.sh wrapper for local lint + breaking-change checks
- Add .github/workflows/buf.yml CI job (path-filtered, breaking check on PR only)
- Add docs/buf.md with installation, usage, rules, and pre-commit hook guide

Closes Stellabill#459
@drips-wave

drips-wave Bot commented Jul 28, 2026

Copy link
Copy Markdown

@DevSolex Great news! 🎉 Based on an automated assessment of this PR, the linked Wave issue(s) no longer count against your application limits.

You can now already apply to more issues while waiting for a review of this PR. Keep up the great work! 🚀

Learn more about application limits

@thlpkee20-wq
thlpkee20-wq merged commit ca45895 into Stellabill:main Jul 29, 2026
4 of 19 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Introduce Buf for OpenAPI and future proto linting

2 participants