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.

Job Cacher plugin

View this plugin on the Plugins site

cache: Caches files from previous build to current build

  • caches
      Array / List of Nested Choice of Objects
    • arbitraryFileCache
      Caches arbitrary paths on the executor back to the item storage cache.
      • path : String
        The path to cache. It can be absolute or relative to the workspace.
      • includes : String
        The pattern to match files that should be included in caching
      • excludes : String
        The pattern to match files that should be excluded from caching
      • cacheName : String (optional)
        The name of the cache (optional). Useful if caching the same path multiple times in a pipeline.
      • cacheValidityDecidingFile : String (optional)
        The workspace-relative path to one or multiple (by using a glob pattern) files which should be used to determine whether the cache is up-to-date or not. Only up-to-date caches will be restored and only outdated caches will be created.
      • compressionMethod (optional)
        The compression method to use
        • Values: NONE, ZIP, TARGZ, TARGZ_BEST_SPEED, TAR, TAR_ZSTD
      • useDefaultExcludes : boolean (optional)
        Whether to use default excludes (see DirectoryScanner#DEFAULTEXCLUDES for more details).
  • maxCacheSize : long (optional)
  • defaultBranch : String (optional)

wrap([$class: 'CacheWrapper']): Job Cacher

Enable caching of files on the executor so that subsequent builds do not need to recreate the files. This is helpful for executors that start clean each time such as docker containers.
  • caches
      Array / List of Nested Choice of Objects
    • arbitraryFileCache
      Caches arbitrary paths on the executor back to the item storage cache.
      • path : String
        The path to cache. It can be absolute or relative to the workspace.
      • includes : String
        The pattern to match files that should be included in caching
      • excludes : String
        The pattern to match files that should be excluded from caching
      • cacheName : String (optional)
        The name of the cache (optional). Useful if caching the same path multiple times in a pipeline.
      • cacheValidityDecidingFile : String (optional)
        The workspace-relative path to one or multiple (by using a glob pattern) files which should be used to determine whether the cache is up-to-date or not. Only up-to-date caches will be restored and only outdated caches will be created.
      • compressionMethod (optional)
        The compression method to use
        • Values: NONE, ZIP, TARGZ, TARGZ_BEST_SPEED, TAR, TAR_ZSTD
      • useDefaultExcludes : boolean (optional)
        Whether to use default excludes (see DirectoryScanner#DEFAULTEXCLUDES for more details).
  • defaultBranch : String (optional)
  • maxCacheSize : long (optional)

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.