Azure / Azure/azure-rest-api-specs
[BreakingChanges] Diff files against themselves to ensure tool doesn't crash
Open
@mikeharder is already working on this.
Since Sep 12, 2024.
- Dominant language
- TypeSpec
- Stars
- 3.1k
- Forks
- 6k
- Avg merge
- 2d 21h
- Merged PRs (30d)
- 432
Description
The BreakingChanges check has a flaw, where it only runs on a file if there is a diff in the PR. So, if a file has a bug so severe it crashes the BreakingChanges check, it won't be detected until later, when the file is changed. This causes significant confusion, because the changes may be unrelated to the original bug.
To mitigate, check BreakingChanges should run on every file in a PR, even if the file is totally new. Any file can be compared "against itself" just to make sure the tool doesn't crash.
Contributor guide
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Assessment
This issue has not been assessed yet.