releasenotes/notes/lf-view-templates-add-64911f643dc053d8.yaml

   1 ---
   2 features:
   3   - |
   4     New view-templates ``common-view`` and ``integration-csit-view`` are
   5     available for projects to manage Jenkins views through code.
   6
   7     To use the ``common-view`` template in a project.
   8
   9     Usage:
  10
  11     .. code-block:: yaml
  12
  13        - project:
  14            ...
  15            views:
  16              - common-view
  17
  18     To use the ``integration-csit-view`` template in a project.
  19
  20     Usage:
  21
  22     .. code-block:: yaml
  23
  24        - project:
  25            ...
  26            views:
  27              - integration-csit-view
  28
  29   - |
  30     A separate project section can be defined for views that are common to a
  31     set of jobs. This creates a list-type view with ``<project-name>`` in
  32     Jenkins which lists all the jobs under the view.
  33
  34     Usage:
  35
  36     .. code-block:: yaml
  37
  38        - project:
  39            name: <project-name-view>
  40            project: <project>
  41            project-name: <project-name>
  42            views:
  43              - common-view
  44
  45     Example Usage:
  46
  47     .. code-block:: yaml
  48
  49        ---
  50        - defaults:
  51            name: global
  52            view-regex: '^{project-name}-.*'
  53            view-description: 'default view description'
  54
  55        - project:
  56            name: project-view
  57            project: project
  58            project-name: project
  59            views:
  60              - common-view
  61
  62        - project:
  63            name: project-stream1
  64            project: project
  65            project-name: project
  66            jobs:
  67              - '{project-name}-{seq}'
  68            seq:
  69              - a
  70              - b
  71
  72        - project:
  73            name: project-stream2
  74            project: project
  75            project-name: project
  76            jobs:
  77              - '{project-name}-{seq}'
  78            seq:
  79              - x
  80              - y
  81
  82        - job-template:
  83            name: '{project-name}-{seq}'