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

Wrap update details in a collapsible group #310

Merged
merged 1 commit into from
Mar 3, 2024

Conversation

zdrve
Copy link
Collaborator

@zdrve zdrve commented Mar 2, 2024

In the ci-and-update output, the details of every changed field, especially for dashboards, can be very large – and that's especially annoying if it's just noise, because they're not your dashboards.

Wrap the update fields in a ::group:: so that they can be collapsed.

billede

https://github.com/zendesk/kennel/actions/runs/8121982186/job/22200952160?pr=22287#step:7:2334

Checklist

  • Verified against local install of kennel (using path: in Gemfile)
  • Added tests
  • Updated Readme.md (if user facing behavior changed)

@@ -22,11 +22,19 @@ def print(plan)

def print_changes(step, list, color)
return if list.empty?

use_groups = ENV.key?("GITHUB_STEP_SUMMARY")
Copy link
Owner

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
use_groups = ENV.key?("GITHUB_STEP_SUMMARY")
use_groups = ENV.key?("GITHUB_STEP_SUMMARY") && item.class::TYPE == :update

@@ -239,6 +240,19 @@ def change(*args)
TEXT
end

it "wraps in a group, if running under GitHub" do
Copy link
Owner

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
it "wraps in a group, if running under GitHub" do
it "wraps in a group to prevent big dumps like dashboard from making things unreadable, if running under GitHub" do

Copy link
Owner

@grosser grosser left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

nice :D

@grosser grosser merged commit 373e321 into master Mar 3, 2024
4 checks passed
@grosser grosser deleted the zdrve/group-update-details branch March 3, 2024 01:33
@grosser
Copy link
Owner

grosser commented Mar 3, 2024

v1.149.0

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

Successfully merging this pull request may close these issues.

2 participants