1073409 - Only display first line of each commit message in result set list

Status: RESOLVED FIXED

(Tree Management :: Treeherder, defect, P2)

Description

[Ed Morley [:emorley]]

Currently with treeherder, for each commit belonging to a result set:
1) The whole multi-line commit message is displayed in the UI
2) This full commit message is also displayed in the tooltip

We should change #1 such that we only display the first line, to improve the SnR when skim reading the list of commits.

Note the similar, but slightly orthogonal bugs:
* Bug 1061283 - Decide whether api/project/<repo>/resultset/ should return multi-line commit comments by default
* Bug 1060612 - Allow first line of commit messages to span multiple lines
(It may be that bug 1061283 means that the full commit message isn't retrieved by default, but we could fetch on demand I guess - and either way let's take the simple fix for SnR now and discuss that one later).

Comment 1

[Ed Morley [:emorley]]

https://github.com/mozilla/treeherder-ui/blob/master/webapp/app/index.html#L123
            <span title="{{escaped_comment}}"><em>{{comments_bug_link}}</em></span>

https://github.com/mozilla/treeherder-ui/blob/master/webapp/app/js/directives/clonejobs.js#L377
                revision.escaped_comment = _.escape(revision.comments);
                revision.comments_bug_link = linkifyBugsFilter(revision.escaped_comment);

Comment 2

[Ed Morley [:emorley]]

Attachment: Only display first line of each commit message

Comment 3

[Treeherder GitHub Bugbot]

Commits pushed to master at https://github.com/mozilla/treeherder-ui

https://github.com/mozilla/treeherder-ui/commit/d02a5f74d8203df4efba0514cfdddcb04b434f18
Bug 1073409 - Rename comments_bug_link to escaped_comment_linkified

To make the relation with 'escaped_comment' clearer.

https://github.com/mozilla/treeherder-ui/commit/2d18e32f710413a912bd03dcdfa85982345c69c4
Bug 1073409 - Only display first line of each commit message

To make the list of commit messages shown for each push less cluttered.
In the future, bug 1061283 will change the API so that there are
separate fields for the first line and full comment message strings, so
at that point we'll switch to using those instead.

Comment 4

[Treeherder GitHub Bugbot]

Commits pushed to master at https://github.com/mozilla/treeherder

https://github.com/mozilla/treeherder/commit/64aafb8b31aa54b1b8988c0b5f87f9a9b2061a74
Bug 1073409 - Rename comments_bug_link to escaped_comment_linkified

To make the relation with 'escaped_comment' clearer.

https://github.com/mozilla/treeherder/commit/25a26880883547014c94ed87278144640af1c20d
Bug 1073409 - Only display first line of each commit message

To make the list of commit messages shown for each push less cluttered.
In the future, bug 1061283 will change the API so that there are
separate fields for the first line and full comment message strings, so
at that point we'll switch to using those instead.