-
Notifications
You must be signed in to change notification settings - Fork 117
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
Fix package_todo update comment #321
Conversation
package_todo.dump | ||
|
||
assert_equal(<<~YAML, file.readlines.first(7).join) | ||
# This file contains a list of dependencies that are not part of the long term plan for buyers. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I'm trying to understand where this buyers
string comes from.
I understand it's interpolated from @package.name
here:
packwerk/lib/packwerk/package_todo.rb
Line 99 in 128d5fc
# This file contains a list of dependencies that are not part of the long term plan for #{@package.name}. |
I don't understand where it's coming from though. Should the string itself be part of this test's setup?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
This is out of scope for this PR but I think we can make that message a bit less confusing by changing it to "the 'buyers' package".
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I've put up a PR to follow up on that thought #323
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
As for the original topic of this thread (sorry for the derailment), it seems that the string is from the destination_package
as implemented at the bottom of the file and used at the top in the setup block. It's not very obvious because of the size of the test file.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Yes, it is from the destination package (see the method in the test case), which would be the one with the violations. It is just confusing in the test because we use tempfiles and mock the setup a bit.
The update-todo subcommand with arguments has been deprecated and is no longer supported.
128d5fc
to
b7d9132
Compare
What are you trying to accomplish?
Fix update command in package TODOs.
What approach did you choose and why?
Remove the arguments from update. The update-todo subcommand with arguments has been deprecated and is no longer supported.
Type of Change
Additional Release Notes
Include any notes here to include in the release description. For example, if you selected "breaking change" above, leave notes on how users can transition to this version.
If no additional notes are necessary, delete this section or leave it unchanged.
Checklist