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

Add report for property changes between versions #3864

Open
theunrepentantgeek opened this issue Mar 12, 2024 · 3 comments
Open

Add report for property changes between versions #3864

theunrepentantgeek opened this issue Mar 12, 2024 · 3 comments

Comments

@theunrepentantgeek
Copy link
Member

theunrepentantgeek commented Mar 12, 2024

Describe the current behavior

With PR #3863 we will have configuration support for renaming properties between versions, but we will still face the challenge of identifying renames that should be added to that configuration.

Describe the improvement

In a similar way that the existing structure.txt files show the object structure for a given version of a resource, add a new report that lists the property changes between versions, to make it easier for those adding a new resource version to identify any required renames.

@theunrepentantgeek
Copy link
Member Author

Braindump of requirements

  • Only resource and object types are included in the report
  • Properties that are present in both versions are omitted
  • Objects that are identical between versions are omitted
  • For each property removed, use the TypoAdvisor to suggest the closest match from the properties added

@matthchr
Copy link
Member

We're still interested in doing this

@theunrepentantgeek
Copy link
Member Author

I still want to do this.

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

No branches or pull requests

2 participants