community-plugins icon indicating copy to clipboard operation
community-plugins copied to clipboard

🐛 Github Actions: Overview table column includes entire commit message

Open marians opened this issue 1 year ago • 0 comments

Plugin Name

github-actions

📜 Description

The action runs overview table has a column MESSAGE showing the entire commit message for the commit that triggered the job run. This message can be very long, especially in the case of GitHub pull requests getting merged with the entire PR description (main comment) used as commit message. It can include markup and emoji.

Since the MESSAGE content is displayed without any truncation and filtering, this can lead to a hard to read table, where line items take up a lot of vertical space.

👍 Expected behavior

Ideally the MESSAGE content should get truncated.

Commit messages often have a short first line that serves the purpose of a headline. User interfaces like GitHub desktop encourage keeping this line short and use subsequent lines for more information.

I suggest to cut off everything from the first newline found (for the MESSAGE column in the table). Also I suggest to apply a hard limit for the number of characters displayed.

In the job run details component, it is fine to show the entire commit message as it is (untruncated).

👎 Actual Behavior with Screenshots

Example screenshot for commit https://github.com/giantswarm/zot/commit/eed0a4256a20fcaf985994475db74923928ff3d5 :

image

This is the latest version 0.6.22.

👟 Reproduction steps

  1. Have a GitHub repo in your catalog that executes actions
  2. Have the github-actions plugin with the overview table configured on the entity page
  3. Create a commit in the GitHub repo with a long message, like in https://github.com/giantswarm/zot/commit/eed0a4256a20fcaf985994475db74923928ff3d5

📃 Provide the context for the Bug.

No response

👀 Have you spent some time to check if this bug has been raised before?

  • [X] I checked and didn't find similar issue

🏢 Have you read the Code of Conduct?

Are you willing to submit PR?

No, but I'm happy to collaborate on a PR with someone else

marians avatar Sep 18 '24 10:09 marians