#3 add buf CI workflow for lint and breaking checks#34
Open
VasilevNStas wants to merge 1 commit into
Open
Conversation
Adds a GitHub Actions workflow that runs buf lint and buf breaking on every pull request against master. Also adds a minimal buf.yaml with STANDARD lint rules (excluding those that fire on the existing codebase: ENUM_VALUE_PREFIX, ENUM_ZERO_VALUE_SUFFIX, FIELD_NOT_REQUIRED, PACKAGE_DIRECTORY_MATCH, PACKAGE_VERSION_SUFFIX). Breaking changes are checked at the FILE level, so any incompatible modification to an existing message, field, or enum is caught before merge. Closes APN-Network#3
Contributor
Author
|
@yegor256 plz review |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Description
The repository has no
.github/workflows/directory and nobuf.yaml, so every push to master and every pull request merges without any automated check that the.protofiles compile cleanly or conform to proto conventions.A duplicate field number, a syntax error, or a breaking wire change would pass review and land in the default branch undetected, then propagate silently to all consumers (Go, Swift, Node).
Changes
buf.yamlwithSTANDARDlint rules (excluding those that fire on existing code:ENUM_VALUE_PREFIX,ENUM_ZERO_VALUE_SUFFIX,FIELD_NOT_REQUIRED,PACKAGE_DIRECTORY_MATCH,PACKAGE_VERSION_SUFFIX)..github/workflows/ci.ymlthat runsbuf lintandbuf breaking --against '.git#branch=master'on every PR.FILElevel, so any incompatible modification to a message, field, or enum is caught before merge.Validation
Both
buf lintandbuf breakingpass locally against the current master.Closes #3