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

Suggest PR Label to Bypass Breaking Change Check #2656

Open
maxmelamed opened this issue Nov 8, 2023 · 1 comment
Open

Suggest PR Label to Bypass Breaking Change Check #2656

maxmelamed opened this issue Nov 8, 2023 · 1 comment

Comments

@maxmelamed
Copy link

Is your feature request related to a problem? Please describe.

When I use the graphql inspector as part of my CI workflow, there are times when breaking changes to the schema are expected. The inspector already supports bypassing breaking change checks with a label, but it does not make clear what the correct label to use is.

Describe the solution you'd like

I'd like the breaking change message to include a suggestion of what label to use in case the breaking change is expected

Describe alternatives you've considered

I could add something to my GH workflow checking the exit code of the graphql inspector and then adding a comment with a suggestion for what label to add, but it seems much cleaner to have it be included in the inspector output instead

Additional context

Happy to put up a PR for this if it seems reasonable :)

@Urigo
Copy link
Collaborator

Urigo commented Nov 23, 2023

Thank you for the offer @maxmelamed , it seems interesting
We would be happy to look at a PR that takes that on!

Do you think we should also improve the docs around this?

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

No branches or pull requests

2 participants