Fix: Update update_dependencies_yml to return a ResourceChange and not a FileChange
#132
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
…ng a new project to the `dependencies.yml` file
dave-connors-3
approved these changes
Aug 21, 2023
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Description and motivations
In issue #127, @graciegoheen found that a
dependencies.ymlfile could be created during connection operations with duplicate projects listed. I was able to determine that this was happening due to theupdate_dependencies_ymlfile performing a bunch of file-level operations and thereby bypassing all of our handy serialization code. Instead, we can avoid this by using theProjectEntityType, which allows us to instead return aResourceChangewith just the new project listing. No more will this method need to read the file's current state and attempt to update it manually. A much better approach IMHO. Along the way, I added an integration test to keep an eye on this in the future.