926ba5970284af53f7800db9d419bab85bf6d92e
[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
21     - status
22     - weather
23     - job
24     - last-success
25     - last-failure
26     - last-duration
27     - build-button
28     - jacoco
29     - find-bugs
30     - robot-list
31
32 :Template Names:
33
34     - common-view
35     - {project-name}
36
37 :Required parameters:
38
39     :project-name: The name of the view.
40     :view-description: View description. (Generally set to 'List of
41         {project-name} jobs' in defaults.yaml)
42     :view-regex: Regex to match the jobs. (Generally set to '^{project-name}-.*'
43         in defaults.yaml)
44
45 :Optional parameters:
46
47     :view-filter-executors: View filter executor. (default: false)
48     :view-filter-queue: View filter queue. (default: false)
49     :view-recurse: View recurse. (default: false)
50
51 Integration CSIT view
52 ---------------------
53
54 Integration CSIT view provides a view for integration or CSIT jobs.
55 The view supports the following set of columns.
56
57 :Columns:
58
59     - status
60     - weather
61     - job
62     - last-success
63     - last-failure
64     - last-duration
65     - build-button
66     - robot-list
67
68 :Template Names:
69
70     - integration-csit-view
71     - {project-name}
72
73 :Required parameters:
74
75     :project-name: The name of the view.
76     :view-description: View description. (Generally set to 'List of
77         {project-name} jobs' in defaults.yaml)
78     :view-regex: Regex to match the jobs. (Generally set to '^{project-name}-.*'
79         in defaults.yaml)
80
81 :Optional parameters:
82
83     :view-filter-executors: View filter executor. (default: false)
84     :view-filter-queue: View filter queue. (default: false)
85     :view-recurse: View recurse. (default: false)