Skip to content

[BEE-37070] add inline documentation for build strategies #388

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.

Sign up for GitHub

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

Open
ampuscas wants to merge 3 commits into
base: master
Choose a base branch
from
Open

[BEE-37070] add inline documentation for build strategies #388

Show file tree
Hide file tree
Changes from 2 commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
4071caa
[BEE-37070] add inline documentation for build strategies
ampuscas Jul 7, 2023
ed564aa
add strategy documentation
ampuscas Jul 7, 2023
09d4261
remove uneccessary help
ampuscas Jul 10, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
3 changes: 2 additions & 1 deletion src/main/resources/jenkins/branch/BranchSource/config.jelly
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -43,7 +43,8 @@
</j:if>
<j:set var="descriptors" value="${descriptor.buildStrategiesDescriptors(it,sourceDescriptor)}"/>
<j:if test="${!descriptors.isEmpty()}">
<f:entry title="${%Build strategies}">
<f:entry title="${%Build strategies}" field="buildStrategies">
Copy link
Member

@jglick jglick Jul 10, 2023

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

So, showing

branch-api-plugin/src/main/resources/jenkins/branch/BranchSource/help-buildStrategies.html

Lines 2 to 4 in 09d4261

By default (i.e. when empty), everything except tags will be automatically built whenever discovered or changed.
If you add at least one strategy then the defaults will be disabled and only the configured strategies will be
applied.

<f:entry title="${%Strategy}" field="strategyId"></f:entry>
<f:hetero-list name="buildStrategies" items="${instance.buildStrategies}"
Copy link
Member

@jglick jglick Jul 7, 2023

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The fake f:entry does not look right. You should not need to resort to tricks to have help for a standard form control. I think the problem here is that the original page used unnecessarily low-level controls. Better to use the higher-level f:repeatableHeteroProperty which groks databinding and should allow you to simply create a file with the conventional name, help-buildStrategies.html.

descriptors="${descriptors}"
hasHeader="true" honorOrder="true"/>
Expand Down
3 changes: 3 additions & 0 deletions src/main/resources/jenkins/branch/BranchSource/help-strategyId.html
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
<div>
<b>Initial Index Build Prevention</b> modifies the indexing behavior so that any branches, pull requests, and tags discovered during the initial indexing create a Pipeline, but will not build it. The pipeline will remain inactive until an SCM event has been made to its corresponding branch/PR/tag.
</div>