Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

chore: Add CI checks for proto generated library validations #11532

Open
HumairAK opened this issue Jan 16, 2025 · 3 comments
Open

chore: Add CI checks for proto generated library validations #11532

HumairAK opened this issue Jan 16, 2025 · 3 comments
Assignees

Comments

@HumairAK
Copy link
Collaborator

Chore description

Various PRs often make changes that affect proto generated go/python libraries. It is often the case that folks forget to regenerated the relevant packages/modules, and they end up getting caught in the release generation scripts: #11531

We should add CI that will fail validation if the generated libraries produce diffs in PRs, if they do the author will need to regenerate and include this as part of their PR.

Labels

/area backend


Love this idea? Give it a 👍.

@chahatsagarmain
Copy link

/assign

@chahatsagarmain
Copy link

chahatsagarmain commented Jan 16, 2025

@HumairAK I was thinking that we could first run the make command to generate protos and check for diff using something like 'git diff' , If the user has not added the generated files this should generate a diff in the workflow run then we can directly fail the job with a diff message . Is this the correct approach ?

@mprahl
Copy link
Contributor

mprahl commented Jan 17, 2025

@HumairAK I was thinking that we could first run the make command to generate protos and check for diff using something like 'git diff' , If the user has not added the generated files this should generate a diff in the workflow run then we can directly fail the job with a diff message . Is this the correct approach ?

This sounds good to me @chahatsagarmain! Thanks for volunteering to take this on.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

No branches or pull requests

3 participants