Refactor the common-view and csit-view template
[releng/global-jjb.git] / releasenotes / notes / lf-view-templates-add-64911f643dc053d8.yaml
index d39b80f..ba77bb4 100644 (file)
@@ -1,83 +1,56 @@
 ---
 features:
   - |
-    New view-templates ``common-view`` and ``integration-csit-view`` are
+    New view-templates ``project-view``, ``common-view``, and ``csit-view`` are
     available for projects to manage Jenkins views through code.
 
-    To use the ``common-view`` template in a project.
-
-    Usage:
+    To use the ``project-view`` template in a project:
 
     .. code-block:: yaml
 
        - project:
-           ...
+           name: aaa-view
            views:
-             - common-view
+             - project-view
 
-    To use the ``integration-csit-view`` template in a project.
+           project-name: aaa
 
-    Usage:
+    To use the ``common-view`` template in a project:
 
     .. code-block:: yaml
 
        - project:
-           ...
+           name: daily-builds
            views:
-             - integration-csit-view
+             - common-view
 
-  - |
-    A separate project section can be defined for views that are common to a
-    set of jobs. This creates a list-type view with ``<project-name>`` in
-    Jenkins which lists all the jobs under the view.
+           view-name: Periodic
+           view-regex: '.*-periodic-.*'
 
-    Usage:
+    To use the ``csit-view`` template in a project:
 
     .. code-block:: yaml
 
        - project:
-           name: <project-name-view>
-           project: <project>
-           project-name: <project-name>
+           name: csit
            views:
-             - common-view
-
-    Example Usage:
+             - csit-view
 
-    .. code-block:: yaml
-
-       ---
-       - defaults:
-           name: global
-           view-regex: '^{project-name}-.*'
-           view-description: 'default view description'
+           view-name: CSIT
+           view-regex: '.*csit.*'
 
        - project:
-           name: project-view
-           project: project
-           project-name: project
+           name: csit-1node
            views:
-             - common-view
-
-       - project:
-           name: project-stream1
-           project: project
-           project-name: project
-           jobs:
-             - '{project-name}-{seq}'
-           seq:
-             - a
-             - b
+             - csit-view
 
-       - project:
-           name: project-stream2
-           project: project
-           project-name: project
-           jobs:
-             - '{project-name}-{seq}'
-           seq:
-             - x
-             - y
+           view-name: CSIT-1node
+           view-regex: '.*-csit-1node-.*'
 
-       - job-template:
-           name: '{project-name}-{seq}'
+upgrade:
+  - |
+    Some LF projects are already using a ``common-view`` template in their
+    local ci-management repo. This ``common-view`` is called ``project-view``
+    in global-jjb so rename all instances of ``common-view`` to
+    ``project-view`` when upgrading and remove the local ``common-view``
+    view-template definition from ci-management.