Details
-
Type:
Bug
-
Status: Closed (View Workflow)
-
Priority:
Minor
-
Resolution: Fixed
-
Component/s: bitbucket-branch-source-plugin, github-branch-source-plugin
-
Labels:
-
Similar Issues:
Description
Summary:
The inline help for behaviors in the betas of the Branch Source plugins don't quite match the options shown in the drop-down menus they are intended to provide help for. For consistency sake, I feel the headers shown inside of help text should match the options in these dropdowns.
Steps to recreate:
1. Configure a GitHub Org Folder job.
2. Under Behaviors --> Discover Branches --> Strategy, observe the options available in the dropdown. They are:
- Only branches that are not also filed as PRs
- Only branches that are also filed as PRs
- All branches
3. Now, view the inline Help. The headings are as follows:
- Exclude branches that are also filed as PRs <-- This is different from the dropdown
- Only branches that are also filed as PRs
- All branches
I feel it would be easier to see things if the first drop-down menu option, and the header for its inline help, were the same words.
For visuals, here's the dropdown exposed:
And here's the help:
Attachments
Issue Links
- links to
Activity
Bitbucket still shows the same issue. This was probably easy to miss, because I said that Bitbucket looked good, but my intention was to describe only the "Discover branches" strategy. With 2.2.0, freshly installed about 15 minutes ago, I still see:
Discover pull requests from origin
Pulldown offers:
- Merging the pull request with the current target branch revision
- The current pull request revision
- Both the current pull request revision and the pull request merged with the current target branch revision
Documentation reads:
- Discover each pull request once with the discovered revision corresponding to the result of merging with the current revision of the target branch
- Discover each pull request once with the discovered revision corresponding to the pull request head revision without merging
- Discover each pull request twice. The first discovered revision corresponds to the result of merging with the current revision of the target branch in each scan. The second parallel discovered revision corresponds to the pull request head revision without merging
Discover pull requests from forks
Pulldown offers:
- Merging the pull request with the current target branch revision
- The current pull request revision
- Both the current pull request revision and the pull request merged with the current target branch revision
Documentation reads:
- Discover each pull request once with the discovered revision corresponding to the result of merging with the current revision of the target branch
- Discover each pull request once with the discovered revision corresponding to the pull request head revision without merging
- Discover each pull request twice. The first discovered revision corresponds to the result of merging with the current revision of the target branch in each scan. The second parallel discovered revision corresponds to the pull request head revision without merging
See above comment about the Bitbucket help/pulldown mismatches that I still see.
Code changed in jenkins
User: Stephen Connolly
Path:
src/main/resources/org/jenkinsci/plugins/github_branch_source/ForkPullRequestDiscoveryTrait/help-strategyId.html
src/main/resources/org/jenkinsci/plugins/github_branch_source/OriginPullRequestDiscoveryTrait/help-strategyId.html
http://jenkins-ci.org/commit/github-branch-source-plugin/980e83f7c5c3b9fd98cf925fbb3fbc7c548adfeb
Log:
[FIXED JENKINS-45343] Use a <dl> to describe the strategies
LGTm. Thanks, Stephen.
Aha! https://github.com/jenkinsci/github-branch-source-plugin/pull/146 nobody has reviewed this yet