18 |
19 |
20 |
16 |
17 |
18 |
19 |
20 |
23 | Jenkins plugin to monitor pull requests with a customizable dashboard.
24 |
25 | Explore the docs »
26 |
27 |
28 | Report Bug
29 | ·
30 | Request Feature
31 |
Portlet content goes here!
352 | 353 |Defines a single portlet for the pull request monitoring dashboard.
7 | * 8 | *The id must be unique. Please make sure that the id is related to the plugin so that 9 | * there are no conflicts with other plugins. It is recommended to use the artifact id 10 | * of the plugin or parts of it as prefix. If several portlets of the same class are created in the 11 | * {@link MonitorPortletFactory}, it must be ensured that {@link #getId()} is always unique for each portlet!
12 | * 13 | * @since 1.6.0 14 | * @author Simon Symhoven 15 | */ 16 | public abstract class MonitorPortlet { 17 | 18 | /** 19 | * Defines the title to be shown. 20 | * 21 | * @return 22 | * the title. 23 | */ 24 | public abstract String getTitle(); 25 | 26 | /** 27 | * Defines the id for the portlet. 28 | * 29 | * @return 30 | * the id. 31 | */ 32 | public abstract String getId(); 33 | 34 | /** 35 | * Defines whether the portlet is shown per default in the dashboard or not. 36 | * The functionality for this is not yet given and the flag is ignored, but the API for it is 37 | * already prepared. 38 | * 39 | * @return 40 | * true if portlet should be shown, false else. 41 | * 42 | * @since 1.6.0 43 | */ 44 | public boolean isDefault() { 45 | return false; 46 | } 47 | 48 | /** 49 | * Defines the preferred width of the portlet. 50 | * 51 | * @return 52 | * the width in pixels. 53 | */ 54 | public abstract int getPreferredWidth(); 55 | 56 | /** 57 | * Defines the preferred height of the portlet. 58 | * 59 | * @return 60 | * the height in pixels. 61 | */ 62 | public abstract int getPreferredHeight(); 63 | 64 | /** 65 | * Defines the icon to show in the dropdown list of available portlets. 66 | * 67 | * @return 68 | * the app relative icon url depending on ${resURL} (/static/cache-id), 69 | * or {@code Optional.empty()}, if a default icon should be added. 70 | * Supported file formats (depending on browser): jpeg, gif, png, apng, svg, bmp, bmp ico, png ico. 71 | */ 72 | public OptionalDefines the {@link ExtensionPoint} to register one or more new pull request monitoring portlets.
10 | * 11 | *The {@link #getDisplayName()} is shown in a dropdown list as optgroup. The children of the optgroup 12 | * are the registered portlets of {@link #getPortlets(Run)}.
13 | * 14 | *Since an empty dashboard is always added by default, it is possible that the method {@link #getPortlets(Run)} will 15 | * be called even though the current run may not be finished. It is therefore advisable to perform a null check on 16 | * the actions of the run required by your portlet and return an empty list if necessary. 17 | * (Example: code-coverage-api)
18 | * 19 | * @since 1.6.0 20 | * @author Simon Symhoven 21 | */ 22 | public abstract class MonitorPortletFactory implements ExtensionPoint { 23 | 24 | /** 25 | * Get a collection of {@link MonitorPortlet} to display. 26 | * 27 | * @param build 28 | * the reference {@link Run}. 29 | * 30 | * @return 31 | * a collection of {@link MonitorPortlet}. 32 | */ 33 | public abstract Collection${%description}
24 | ${unavailablePortlets}
${it.title}
6 | 7 |${%description}
6 | 7 |${%noPullRequest}
32 | 33 |
59 |
60 | ${%contributor}: ${contributorMetadata.isPresent() ?
61 | contributorMetadata.get().getContributor() : 'unknown'}
62 |
63 | ${%source}: ${it.getScmHead(job).getOriginName()}
64 |
65 | ${%target}: ${it.getScmHead(job).getTarget().getName()}
66 |
67 |
24 | ${%configModal.title}
25 |
26 | ${it.hasChanges()}
41 | 42 |