Fix help display behaviors in the trait list UI by dodo920306 · Pull Request #328 · jenkinsci/scm-api-plugin

dodo920306 · 2025-05-19T12:18:01Z

Wrap helpLink and helpArea in a .help-sibling container to ensure help content appears under the correct entry, rather than always in the first block. Also moved the helpLink inline with displayName inside the same to improve layout.

Fixes confusing UX in repeatable entries
Matches Jenkins' help JavaScript behavior (finds closest .help-sibling)

Before:

After:

Testing done

Submitter checklist

Make sure you are opening from a topic/feature/bugfix branch (right side) and not your main branch!
Ensure that the pull request title represents the desired changelog entry
Please describe what you did
Link to relevant issues in GitHub or Jira
Link to relevant pull requests, esp. upstream and downstream changes
Ensure you have provided tests that demonstrate the feature works or the issue is fixed

Wrap helpLink and helpArea in a `.help-sibling` container to ensure help content appears under the correct entry, rather than always in the first block. Also moved the helpLink inline with displayName inside the same <td> to improve layout. - Fixes confusing UX in repeatable entries - Matches Jenkins' help JavaScript behavior (finds closest `.help-sibling`) - Removes unnecessary <div> wrapping displayName

dodo920306 · 2025-08-19T00:50:42Z

@jenkinsci/scm-api-plugin-developers Any update?

jglick · 2025-09-17T22:46:37Z

            </local:td>
-            <f:helpLink url="${help}"/>
          </local:row>
          <!-- TODO: help support is unintuitive; people should be able to see help from drop-down menu -->


dates to #36 FTR; amended in #82

jglick · 2025-09-17T22:52:12Z

@timja any idea if this help-sibling was ever intended as an API?

The whole file seems rather suspicious to me. You should not need all of this boilerplate just to add a list of traits to an object, something that can be done much more easily with the standard f:repeatableHeteroProperty as for example in jenkinsci/oic-auth-plugin#644. I think the only thing we get out of this complexity is the visual categorization of traits into sections.

timja · 2025-09-18T08:20:04Z

This change itself seems fine, much better that it is on the same line.

@timja any idea if this help-sibling was ever intended as an API?

Ideally it should not be used outside of core to reduce the changes needed to be made in the ecosystem if / when the markup ever changes, it predates public APIs vs internal for CSS in core though.

It is used in a number of places outside core: https://github.com/search?q=org%3Ajenkinsci+help-sibling&type=code

The whole file seems rather suspicious to me. You should not need all of this boilerplate just to add a list of traits to an object, something that can be done much more easily with the standard f:repeatableHeteroProperty as for example in jenkinsci/oic-auth-plugin#644. I think the only thing we get out of this complexity is the visual categorization of traits into sections.

It would be better is the section support could be added to core and then removed from here, not looked into the feasibility of that though.

dodo920306 · 2025-09-24T03:31:41Z

So...should I change anything?

timja · 2025-09-24T07:46:31Z

+            <local:td>
+              <b>${descriptor.displayName}</b>
+              <f:helpLink url="${help}"/>
+            </local:td>


This wasn't merged properly with #338:

Suggested change

<local:td>

<b>${descriptor.displayName}</b>

<f:helpLink url="${help}"/>

</local:td>

${descriptor.displayName}

<f:helpLink url="${help}"/>

Interestingly local:td doesn't exist and its being being outputted directly to the html as:

<local:td xmlns:local="local"> ...

timja

I just checked with master and this was fixed in #338, these changes aren't required.

cc @janfaracik

jglick · 2025-10-01T16:22:23Z

#328 (review)

dodo920306 · 2025-10-02T07:13:08Z

@jglick @timja Wait. What? You can't close this. The problem still remains even with the latest version of this plugin!

I thought #328 (review) was talking about the change in the review rather than this whole PR. Anyway, please reopen this 🙏.

timja · 2025-10-02T08:16:13Z

In my testing it did not exist anymore. The video you have attached shows no issue that I can see?

dodo920306 · 2025-10-02T09:15:53Z

In my testing it did not exist anymore. The video you have attached shows no issue that I can see?

@timja Well, in the first sentence of my PR I said

Wrap helpLink and helpArea in a .help-sibling container to ensure help content appears under the correct entry, rather than always in the first block.

No matter what you originally thought this PR tried to resolve, the main issue I want to address here is the problem that the help messages don't show in their own option block and can't be shown at the same time separately.

The correct behavior after this PR got merged should be like the GIF I showed in the PR

In my testing it did not exist anymore. The video you have attached shows no issue that I can see?

The problen of that video is when I clicked another option help message while the other is still opened, the original message got closed with the message I want to see only open in the first entry after I clicked again. I believe it's more intuitive to make help messages show wherever and whenever users click.

timja · 2025-10-02T12:53:00Z

    <d:tag name="body">
      <div>
        <j:set var="help" value="${descriptor.helpFile}"/>
+        <div class="help-sibling" style="width:100%">


I doubt this style is needed:

Suggested change

<div class="help-sibling" style="width:100%">

<div class="help-sibling">

timja · 2025-10-02T12:54:01Z

I see, I misunderstood that there is two bugs here, the display of the help icons is fixed but there's an issue with opening and closing of the help areas.

If you can resolve the comments I'll take another look

Signed-off-by: dodo920306 <dodo920306@gmail.com>

dodo920306 · 2025-10-03T02:21:01Z

Like this, you meant?

timja · 2025-10-03T08:09:21Z

Like this, you meant?

Mostly, I fixed the merge for you in a2b65e1

timja

Thanks! I tested on master and reproduced the issue and can no longer reproduce it with this fix.

jglick

Final diff does not appear harmful. Do not know anything about the bug or the fix. @timja maybe you want to be added to the repo so you can help maintain stuff like this yourself?

dodo920306 requested a review from a team as a code owner May 19, 2025 12:18

Merge branch 'master' into fix/help-display-ui-behaviors

bbb44bb

jglick reviewed Sep 17, 2025

View reviewed changes

jglick requested a review from timja September 17, 2025 22:48

Merge branch 'master' into fix/help-display-ui-behaviors

6e0a5f3

timja reviewed Sep 24, 2025

View reviewed changes

timja requested changes Sep 24, 2025

View reviewed changes

Merge branch 'master' into fix/help-display-ui-behaviors

4b36def

jglick closed this Oct 1, 2025

timja reopened this Oct 2, 2025

timja reviewed Oct 2, 2025

View reviewed changes

Remove the redundant style and element

9758454

Signed-off-by: dodo920306 <dodo920306@gmail.com>

timja reviewed Oct 3, 2025

View reviewed changes

Comment thread src/main/resources/jenkins/scm/api/form/traits.jelly Outdated

Update src/main/resources/jenkins/scm/api/form/traits.jelly

a2b65e1

timja added the bug label Oct 3, 2025

timja approved these changes Oct 3, 2025

View reviewed changes

timja requested a review from jglick October 3, 2025 13:34

jglick approved these changes Oct 3, 2025

View reviewed changes

jglick added this pull request to the merge queue Oct 3, 2025

Merged via the queue into jenkinsci:master with commit ae7ca4d Oct 3, 2025
17 checks passed

timja mentioned this pull request Oct 3, 2025

Add timja to scm-api jenkins-infra/repository-permissions-updater#4665

Merged

7 tasks

dodo920306 deleted the fix/help-display-ui-behaviors branch October 7, 2025 01:11

	<div class="help-sibling" style="width:100%">
	<div class="help-sibling">

Conversation

dodo920306 commented May 19, 2025

Testing done

Submitter checklist

Uh oh!

dodo920306 commented Aug 19, 2025

Uh oh!

jglick Sep 17, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

jglick commented Sep 17, 2025

Uh oh!

timja commented Sep 18, 2025

Uh oh!

dodo920306 commented Sep 24, 2025

Uh oh!

timja Sep 24, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

timja left a comment • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

jglick commented Oct 1, 2025

Uh oh!

dodo920306 commented Oct 2, 2025

Uh oh!

timja commented Oct 2, 2025

Uh oh!

dodo920306 commented Oct 2, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

timja Oct 2, 2025

Choose a reason for hiding this comment

Uh oh!

timja commented Oct 2, 2025

Uh oh!

dodo920306 commented Oct 3, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

Uh oh!

timja commented Oct 3, 2025

Uh oh!

timja left a comment

Choose a reason for hiding this comment

Uh oh!

jglick left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants

jglick Sep 17, 2025 •

edited

Loading

timja Sep 24, 2025 •

edited

Loading

timja left a comment •

edited

Loading

dodo920306 commented Oct 2, 2025 •

edited

Loading

dodo920306 commented Oct 3, 2025 •

edited

Loading