tools/data-api-differ
: updating the output for non-breaking changes
#3575
Labels
tools/data-api-differ
: updating the output for non-breaking changes
#3575
Follow on to #3573
The Data API Differ tool allows for highlighting the changes between two sets of API Definitions (typically between those in
main
and those in a pull request), which are output as one of many types of Changes found within this package.These changes then allow us to determine and render the:
Between two sets of API Definitions (typically between the
main
branch and a pull request containing the updated API Definitions) - one such example of this can be found in the comments on this Pull Request.Whilst the outputs for
Breaking Changes
andNew Static Identifiers
are succinct, when a new API Version/Resource contains a significant number of items (e.g. Constants/Models/Operations/Resource IDs) theNon-Breaking Changes
can be extremely long - for example in the case of #3570 this is output as 6420 lines ofchanges, of which over 5000 lines are from a new API Version for the
Network
Service - which both exceeds the maximum size of a comment (on Github) and is hard to read.That said - having this granular level of diffing is extremely useful in identifying issues that can be introduced day-to-day as the upstream API Definitions get updated, as such
#3573 looked to simplify this by skipping outputting any nested items (e.g. Constants/Models/Operations/Resource IDs) when a new API Resource is added.
As such this issue tracks updating the output so that the differences are more easily readable - and need to ensure we consider:
It'd probably make sense to have a summary and then more specific sections, we've talked about using expandable/collapsable markdown blocks to render this - however it's also possible to render a larger set of changes onto the Github Action itself (in addition to/as an alternative to commenting on the associated PR) - so perhaps it'd be worth having a summary of changes, and then a link to the associated comment on the Github Action result? e.g.
The text was updated successfully, but these errors were encountered: