013dfbe5594060b40211024810a9092e992f58a9
[releng/global-jjb.git] / docs / jjb / lf-views.rst
1 .. _lf-global-jjb-views:
2
3 #############
4 Jenkins Views
5 #############
6
7 View Templates
8 ==============
9
10 JJB view-templates provides a way to manage Jenkins views through code.
11
12
13 Common view
14 -----------
15
16 Common view groups jobs related to a project and supports the following
17 columns.
18
19 :Columns:
20     - status
21     - weather
22     - job
23     - last-success
24     - last-failure
25     - last-duration
26     - build-button
27     - jacoco
28     - find-bugs
29     - robot-list
30
31 :Template Names:
32     - common-view
33     - {project-name}
34
35 :Required parameters:
36
37     :project-name: The name of the view.
38     :view-description: View description. (Generally set to 'List of
39         {project-name} jobs' in defaults.yaml)
40     :view-filter-executors: View filter executor. (Generally set to 'false' in
41         defaults.yaml)
42     :view-filter-queue: View filter queue. (Generally set to 'false' in
43         defaults.yaml)
44     :view-regex: Regex to match the jobs. (Generally set to '^{project-name}-.*'
45         in defaults.yaml)
46     :view-recurse: View recurse. (Generally set to 'false' in defaults.yaml)
47
48 Integration CSIT view
49 ---------------------
50
51 Integration CSIT view provides a view for integration or CSIT jobs.
52 The view supports the following set of columns.
53
54 :Columns:
55     - status
56     - weather
57     - job
58     - last-success
59     - last-failure
60     - last-duration
61     - build-button
62     - robot-list
63
64 :Template Names:
65     - integration-csit-view
66     - {project-name}
67
68 :Required parameters:
69
70     :project-name: The name of the view.
71     :view-description: View description. (Generally set to 'List of
72         {project-name} jobs' in defaults.yaml)
73     :view-filter-executors: View filter executor. (Generally set to 'false' in
74         defaults.yaml)
75     :view-filter-queue: View filter queue. (Generally set to 'false' in
76         defaults.yaml)
77     :view-regex: Regex to match the jobs. (Generally set to '^{project-name}-.*'
78         in defaults.yaml)
79     :view-recurse: View recurse. (Generally set to 'false' in defaults.yaml)