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

Provide source code lines when reporting breaking changes #574

Open
languitar opened this issue Jul 3, 2024 · 4 comments
Open

Provide source code lines when reporting breaking changes #574

languitar opened this issue Jul 3, 2024 · 4 comments
Labels
enhancement New feature or request

Comments

@languitar
Copy link

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

Currently, breaking change detection provides no source code lines. As a result, the annotations placed in GitHub via the githubactions format are always attached to the first line of the file. This makes it harder than necessary to trace the origin of the problematic source code change.

Describe the solution you'd like

Where possible, detected breaking changes should be associated with the source line of the closes affected concept. For instance, if a mandatory property is removed from a model, then the source code line could be the start of the model or, even better, the line the removal took place.

Describe alternatives you've considered

None

Additional context

None

@languitar languitar changed the title Provie source code lines when reporting breaking changes Provide source code lines when reporting breaking changes Jul 3, 2024
@reuvenharrison reuvenharrison added the enhancement New feature or request label Jul 4, 2024
@reuvenharrison
Copy link
Collaborator

Are your specs written in json or yaml?

@languitar
Copy link
Author

We use yaml

@reuvenharrison
Copy link
Collaborator

Looks like we may have a way to implement this but it requires some heavy lifting.
Before making this investment, it would be great to hear from users how much value this would provide.

@reuvenharrison
Copy link
Collaborator

For other people looking at this, here is a demonstration of this limitation:
https://github.com/oasdiff/github-demo/actions/runs/9797247511
When clicking the annotations you get redirected to the first line of the spec instead of the specific line that was changed.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement New feature or request
Projects
None yet
Development

No branches or pull requests

2 participants