List View

The view list module handles creating Jenkins List views.

To create a list view specify list in the view-type attribute to the List View definition.

View Parameters:
 
  • name (str): The name of the view.

  • view-type (str): The type of view.

  • description (str): A description of the view. (default ‘’)

  • filter-executors (bool): Show only executors that can execute the included views. (default false)

  • filter-queue (bool): Show only included jobs in builder queue. (default false)

  • job-name (list): List of jobs to be included.

  • job-filters (dict): Job filters to be included. Requires View Job Filters

    • most-recent (dict)
      most-recent:
      • max-to-include (int): Maximum number of jobs to include. (default 0)
      • check-start-time (bool): Check job start time. (default false)
    • build-duration (dict)
      build-duration:
      • match-type (‘str’): Jobs that match a filter to include. (default includeMatched)
      • build-duration-type (‘str’): Duration of the build. (default Latest)
      • amount-type: (‘str’): Duration in hours, days or builds. (default Hours)
      • amount: (‘int’): How far back to check. (default 0)
      • less-than: (‘bool’): Check build duration less than or more than. (default True)
      • build-duration-minutes: (‘int’): Build duration minutes. (default 0)
    • build-trend (dict)
      build-trend:
      • match-type (‘str’): Jobs that match a filter to include. (default includeMatched)
      • build-trend-type (‘str’): Duration of the build. (default Latest)
      • amount-type: (‘str’): Duration in hours, days or builds. (default Hours)
      • amount: (‘int’): How far back to check. (default 0)
      • status: (‘str’): Job status. (default Completed)
    • job-status (dict)
      job-status:
      • match-type (‘str’): Jobs that match a filter to include. (default includeMatched)
      • unstable (‘bool’): Jobs with status unstable. (default False)
      • failed (‘bool’): Jobs with status failed. (default False)
      • aborted (‘bool’): Jobs with status aborted. (default False)
      • disabled (‘bool’): Jobs with status disabled. (default False)
      • stable (‘bool’): Jobs with status stable. (default False)
    • fallback (dict)
      fallback:
      • fallback-type (‘str’): Fallback type to include/exclude for all jobs in a view, if no jobs have been included by previous filters. (default REMOVE_ALL_IF_ALL_INCLUDED)
    • build-status (dict)
      build-status:
      • match-type (‘str’): Jobs that match a filter to include. (default includeMatched)
      • never-built (‘bool’): Jobs that are never built. (default False)
      • building (‘bool’): Jobs that are being built. (default False)
      • in-build-queue (‘bool’): Jobs that are in the build queue. (default False)
    • user-relevence (dict)
      user-relevence:
      • match-type (‘str’): Jobs that match a filter to include. (default includeMatched)
      • build-count (‘str’): Count of builds. (default AtLeastOne)
      • amount-type: (‘str’): Duration in hours, days or builds. (default Hours)
      • amount: (‘int’): How far back to check. (default 0)
      • match-user-id (‘bool’): Jobs matching user-id. (default False)
      • match-user-fullname (‘bool’): Jobs matching user fullname. (default False)
      • ignore-case (‘bool’): Ignore case. (default False)
      • ignore-whitespace (‘bool’): Ignore whitespace. (default False)
      • ignore-non-alphaNumeric (‘bool’): Ignore non-alphaNumeric. (default False)
      • match-builder (‘bool’): Jobs matching builder. (default False)
      • match-email (‘bool’): Jobs matching email. (default False)
      • match-scm-changes (‘bool’): Jobs matching scm changes. (default False)
    • regex-job (dict)
      regex-job:
      • match-type (‘str’): Jobs that match a filter to include. (default includeMatched)
      • regex-name (‘str’): Regular expression name. (default ‘’)
      • regex (‘str’): Regular expression. (default ‘’)
    • job-tpye (dict)
      job-type:
      • match-type (‘str’): Jobs that match a filter to include. (default includeMatched)
      • job-type (‘str’): Type of Job. (default hudson.model.FreeStyleProject)
    • parameter (dict)
      parameter:
      • match-type (‘str’): Jobs that match a filter to include. (default includeMatched)
      • name (‘str’): Job name to match. (default ‘’)
      • value (‘str’): Value to match. (default ‘’)
      • desc (‘str’): Description to match. (default ‘’)
      • use-default-value (‘bool’): Use default value. (default False)
      • match-builds-in-progress (‘bool’): Match build in progress. (default False)
      • match-all-builds (‘bool’): Match all builds. (default False)
      • max-builds-to-match (‘int’): Maximum builds to match. (default 0)
    • other-views (dict)
      other-views:
      • match-type (‘str’): Jobs that match a filter to include. (default includeMatched)
      • view-name (‘str’): View name. (default select a view other than this one)
    • scm (dict)
      scm:
      • match-type (‘str’): Jobs that match a filter to include. (default includeMatched)
      • scm-type (‘str’): Type of SCM. (default hudson.scm.NullSCM)
    • secured-job (dict)
      secured-job:
      • match-type (‘str’): Jobs that match a filter to include. (default includeMatched)
    • user-permissions (dict)
      user-permissions:
       
      • match-type (‘str’): Jobs that match a filter to include. (default includeMatched)
      • configure (‘bool’): User with configure permissions. (default false)
      • amount-type: (‘bool’): User with build permissions. (default false)
      • amount: (‘bool’): User with workspace permissions. (default false)
      • permission-check: (‘str’): Match user permissions. (default MustMatchAll)
    • upstream-downstream (dict)
      upstream-downstream:
       
      • include-upstream (‘bool’): Jobs that match upstream. (default False)
      • include-downstream (‘bool’): Jobs that match downstream. (default False)
      • recursive (‘bool’): Jobs that are recursive. (default False)
      • exclude-originals (‘bool’): Jobs that are originals. (default False)
    • unclassified (dict)
      unclassified:
      • match-type (‘str’): Jobs that match a filter to include. (default includeMatched)
  • columns (list): List of columns to be shown in view.

  • regex (str): . Regular expression for selecting jobs (optional)

  • recurse (bool): Recurse in subfolders.(default false)

  • status-filter (bool): Filter job list by enabled/disabled status. (optional)

Example:

name: list-view-name01
view-type: list
description: 'Sample description'
filter-executors: true
filter-queue: true
job-name:
    - job-name-1
    - job-name-3
    - job-name-2
columns:
    - status
    - weather
    - job
    - last-success
    - last-failure
    - last-duration
    - build-button
    - last-stable
    - robot-list
    - find-bugs
    - jacoco
    - git-branch
    - schedule-build
    - priority-sorter
    - build-filter
    - desc
recurse: true
status-filter: false

Example:

name: regex-example
view-type: list
description: 'description'
columns:
    - status
    - weather
    - job
    - last-success
    - last-failure
    - last-duration
regex: (?!test.*).*