Use table summary for large groups of dependencies #7463
Merged
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
When five or more dependencies are being updated in a pull request, render the updates as a table for legibility.
Nishnha
reviewed
Jun 21, 2023
Comment on lines
428
to
445
| def table(rows) | ||
| [ | ||
| table_header(rows[0]), | ||
| rows[1..].map { |r| table_row(r) }, | ||
| ].join("\n") | ||
| end | ||
|
|
||
| def table_header(row) | ||
| [ | ||
| table_row(row), | ||
| table_row(["---"] * row.count), | ||
| ].join("\n") | ||
| end | ||
|
|
||
| def table_row(row) | ||
| "| #{row.join(' | ')} |" | ||
| end | ||
|
|
There was a problem hiding this comment.
This is a really clean interface. Thanks!
Nishnha
reviewed
Jun 21, 2023
Nishnha
reviewed
Jun 21, 2023
Comment on lines
+325
to
329
| elsif update_count > 1 | ||
| " #{dependency_links[0..-2].join(', ')} and #{dependency_links[-1]}." | ||
| else | ||
| ": #{dependency_links.first}." | ||
| " #{dependency_links.first}." | ||
| end |
There was a problem hiding this comment.
Can we also add a test for when there are less than 5 updates to make sure the formatting is correct outside of a table?
There was a problem hiding this comment.
That should be covered by a few existing tests:
Nishnha
approved these changes
Jun 26, 2023
brettfo
pushed a commit
to brettfo/dependabot-core
that referenced
this pull request
Oct 11, 2023
Use table summary for large groups of dependencies
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.
When a pull request is being created that updates five or more dependencies, render the updates as a table for legibility.