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

Improvements to GitHub App Plan Comments #490

Open
datfinesoul opened this issue Jul 10, 2023 · 0 comments
Open

Improvements to GitHub App Plan Comments #490

datfinesoul opened this issue Jul 10, 2023 · 0 comments
Labels
enhancement New feature or request usability usability

Comments

@datfinesoul
Copy link
Contributor

datfinesoul commented Jul 10, 2023

Is your feature request related to a problem? Please describe.

image
image

Describe the solution you'd like

Since these plans show up every time a change is made, It would be nice if the entire comment was in a collapsible block, or if the comment block is re-used instead of having multiple of them pile up.

  1. In it's current form, I feel like this section doesn't really provide a lot of useful info.
    • "Distinct actions" doesn't mean anything to me. If this is meant to be add/update/delete, then having some abbreviated counts here might be good.
    • "Templates with changes" is too high level to be meaningful. Breakdown by resource type here might nice, in favor of removing clicks from 4)
    • "Accounts" is moderately useful, because it gives some meaningful scope.
      In its current form, I'd almost rather have this section be collapsed to save room.
  2. If there are no exceptions, it would be great if this section could just be omitted. This is just extra text when there are no errors.
  3. This section is too click intensive. This is the information I would like to see the most. I believe the number of collapsible sections here is too high for somebody to effectively use this comment as a way to review the plan.
  4. The run link for me pointed to https://github.com/undefined-io/iambic-templates/pull/None, which was a 404. It's also just not clear what "run" in this context actually means. If this section could instead include information about running apply using iambic apply that would be a bit more useful. Or at least a link to the docs about what to do next.

Describe alternatives you've considered
The main thing about these types of PR comment plans should be to provide as much easily reviewable information as possible in the smallest amount of space, with the least amount of clicks IMO. Anything that is no helpful to a reviewer doesn't need to be shown. And if there are links, it should be clear what they will do when clicked.

Additional context

Community Engagement
Help us prioritize this request and express your support by adding a 👍 reaction to the original issue. This will assist both the community and the maintainers in addressing this request.

Please avoid leaving "+1" or "me too" comments as they create extra noise for issue followers and do not assist in prioritizing the request. If you are considering working on this issue or have already submitted a pull request, kindly leave a comment.

@smoy smoy added the enhancement New feature or request label Jul 10, 2023
@smoy smoy added the usability usability label Aug 3, 2023
smoy pushed a commit that referenced this issue Aug 5, 2023
* If we don't have a valid url, don't include the fragment
smoy added a commit that referenced this issue Aug 5, 2023
Address part of #490. Name the hyperlink with more details
smoy added a commit that referenced this issue Aug 7, 2023
Addresses some of #490 Plan output improvement
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement New feature or request usability usability
Projects
None yet
Development

No branches or pull requests

2 participants