The following plugin provides functionality available through Pipeline-compatible steps. Read more about how to integrate steps into your Pipeline in the Steps section of the Pipeline Syntax page.

For a list of other such plugins, see the Pipeline Steps Reference page.

Task Scanner Plug-in

openTasks: Scan workspace for open tasks

  • asRegexp (optional)
    • Type: boolean
  • canComputeNew (optional)
    • Type: boolean
  • canResolveRelativePaths (optional)
    • Type: boolean
  • canRunOnFailed (optional)
    • Type: boolean
  • defaultEncoding (optional)
    • Type: String
  • excludePattern (optional)

    Patterns look very much like the patterns used in DOS and UNIX:

    '*' matches zero or more characters, '?' matches one character.

    In general, patterns are considered relative paths, relative to the Jenkins workspace. Only files found below that base directory are considered. So while a pattern like ../foo.java is possible, it will not match anything when applied since the base directory's parent is never scanned for files.

    Examples:

    *.java   matches   .java , x.java and FooBar.java , but not FooBar.xml (does not end with .java ).

    ?.java   matches   x.java , A.java , but not .java or xyz.java (both don't have one character before .java ).

    Combinations of * 's and ? 's are allowed.

    Matching is done per-directory. This means that first the first directory in the pattern is matched against the first directory in the path to match. Then the second directory is matched, and so on. For example, when we have the pattern /?abc/*/*.java and the path /xabc/foobar/test.java , the first ?abc is matched with xabc , then * is matched with foobar , and finally *.java is matched with test.java . They all match, so the path matches the pattern.

    To make things a bit more flexible, we add one extra feature, which makes it possible to match multiple directory levels. This can be used to match a complete directory tree, or a file anywhere in the directory tree. To do this, ** must be used as the name of a directory. When ** is used as the name of a directory in the pattern, it matches zero or more directories. For example: /test/** matches all files/directories under /test/ , such as /test/x.java , or /test/foo/bar/xyz.html , but not /xyz.xml .

    There is one "shorthand": if a pattern ends with / or \ , then ** is appended. For example, mypackage/test/ is interpreted as if it were mypackage/test/** .

    Example patterns:

    **/CVS/* Matches all files in CVS directories that can be located anywhere in the directory tree.
    Matches:
          CVS/Repository
          org/apache/CVS/Entries
          org/apache/jakarta/tools/ant/CVS/Entries
          
    But not:
          org/apache/CVS/foo/bar/Entries (foo/bar/
          part does not match)
          
    org/apache/jakarta/** Matches all files in the org/apache/jakarta directory tree.
    Matches:
          org/apache/jakarta/tools/ant/docs/index.html
          org/apache/jakarta/test.xml
          
    But not:
          org/apache/xyz.java
          
    (jakarta/ part is missing).
    org/apache/**/CVS/* Matches all files in CVS directories that are located anywhere in the directory tree under org/apache.
    Matches:
          org/apache/CVS/Entries
          org/apache/jakarta/tools/ant/CVS/Entries
          
    But not:
          org/apache/CVS/foo/bar/Entries
          
    (foo/bar/ part does not match)
    **/test/** Matches all files that have a test element in their path, including test as a filename.
    • Type: String
  • failedNewAll (optional)
    • Type: String
  • failedNewHigh (optional)
    • Type: String
  • failedNewLow (optional)
    • Type: String
  • failedNewNormal (optional)
    • Type: String
  • failedTotalAll (optional)
    • Type: String
  • failedTotalHigh (optional)
    • Type: String
  • failedTotalLow (optional)
    • Type: String
  • failedTotalNormal (optional)
    • Type: String
  • healthy (optional)
    • Type: String
  • high (optional)
    • Type: String
  • ignoreCase (optional)
    • Type: boolean
  • low (optional)
    • Type: String
  • normal (optional)
    • Type: String
  • pattern (optional)

    Patterns look very much like the patterns used in DOS and UNIX:

    '*' matches zero or more characters, '?' matches one character.

    In general, patterns are considered relative paths, relative to the Jenkins workspace. Only files found below that base directory are considered. So while a pattern like ../foo.java is possible, it will not match anything when applied since the base directory's parent is never scanned for files.

    Examples:

    *.java   matches   .java , x.java and FooBar.java , but not FooBar.xml (does not end with .java ).

    ?.java   matches   x.java , A.java , but not .java or xyz.java (both don't have one character before .java ).

    Combinations of * 's and ? 's are allowed.

    Matching is done per-directory. This means that first the first directory in the pattern is matched against the first directory in the path to match. Then the second directory is matched, and so on. For example, when we have the pattern /?abc/*/*.java and the path /xabc/foobar/test.java , the first ?abc is matched with xabc , then * is matched with foobar , and finally *.java is matched with test.java . They all match, so the path matches the pattern.

    To make things a bit more flexible, we add one extra feature, which makes it possible to match multiple directory levels. This can be used to match a complete directory tree, or a file anywhere in the directory tree. To do this, ** must be used as the name of a directory. When ** is used as the name of a directory in the pattern, it matches zero or more directories. For example: /test/** matches all files/directories under /test/ , such as /test/x.java , or /test/foo/bar/xyz.html , but not /xyz.xml .

    There is one "shorthand": if a pattern ends with / or \ , then ** is appended. For example, mypackage/test/ is interpreted as if it were mypackage/test/** .

    Example patterns:

    **/CVS/* Matches all files in CVS directories that can be located anywhere in the directory tree.
    Matches:
          CVS/Repository
          org/apache/CVS/Entries
          org/apache/jakarta/tools/ant/CVS/Entries
          
    But not:
          org/apache/CVS/foo/bar/Entries (foo/bar/
          part does not match)
          
    org/apache/jakarta/** Matches all files in the org/apache/jakarta directory tree.
    Matches:
          org/apache/jakarta/tools/ant/docs/index.html
          org/apache/jakarta/test.xml
          
    But not:
          org/apache/xyz.java
          
    (jakarta/ part is missing).
    org/apache/**/CVS/* Matches all files in CVS directories that are located anywhere in the directory tree under org/apache.
    Matches:
          org/apache/CVS/Entries
          org/apache/jakarta/tools/ant/CVS/Entries
          
    But not:
          org/apache/CVS/foo/bar/Entries
          
    (foo/bar/ part does not match)
    **/test/** Matches all files that have a test element in their path, including test as a filename.
    • Type: String
  • shouldDetectModules (optional)
    • Type: boolean
  • thresholdLimit (optional)
    • Type: String
  • unHealthy (optional)
    • Type: String
  • unstableNewAll (optional)
    • Type: String
  • unstableNewHigh (optional)
    • Type: String
  • unstableNewLow (optional)
    • Type: String
  • unstableNewNormal (optional)
    • Type: String
  • unstableTotalAll (optional)
    • Type: String
  • unstableTotalHigh (optional)
    • Type: String
  • unstableTotalLow (optional)
    • Type: String
  • unstableTotalNormal (optional)
    • Type: String
  • useDeltaValues (optional)
    • Type: boolean
  • usePreviousBuildAsReference (optional)
    • Type: boolean
  • useStableBuildAsReference (optional)
    • Type: boolean

Was this page helpful?

Please submit your feedback about this page through this quick form.

Alternatively, if you don't wish to complete the quick form, you can simply indicate if you found this page helpful?

    


See existing feedback here.