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.

$class: 'CVSSCM'

  • $class: 'CVSSCM'
    • repositories
        Array / List of Nested Object
      • cvsRoot : String
        The CVS connection string Jenkins uses to connect to the server. The format is the same as $CVSROOT environment variable (:protocol:user@host:path)
      • passwordRequired : boolean
      • password : String
      • repositoryItems
          Array / List of Nested Object
        • location
            Nested Choice of Objects
          • $class: 'BranchRepositoryLocation'
            • branchName : String
            • useHeadIfNotFound : boolean
          • $class: 'HeadRepositoryLocation'
            • $class: 'TagRepositoryLocation'
              • tagName : String
              • useHeadIfNotFound : boolean
          • modules
              Array / List of Nested Object
            • remoteName : String
              The name of the module in the repository at CVSROOT
            • localName : String
              The name to be applied to this module in the local workspace. If this is left blank then the remote module name will be used. This is similar to the 'checkout-as' function available on many CVS clients.
            • projectsetFileName : String
              The name of the file in this module to parse for projectset entries.
        • excludedRegions
          If set, and Jenkins is set to poll for changes, Jenkins will ignore any files and/or folders in this list when determining if a build needs to be triggered.

          Each exclusion uses regular expression pattern matching, and must be separated by a new line.

          The example above illustrates that if only html/jpeg/gif files have been committed to the SCM a build will not occur.

          More information on regular expressions can be found here.
            Array / List of Nested Object
          • pattern : String
        • compressionLevel : int
        • repositoryBrowser
            Nested Choice of Objects
          • $class: 'FishEyeCVS'
            • url : String
              Specify the root URL of FishEye for this repository (such as this.)
          • $class: 'OpenGrok'
            • url : String
              Specify the root URL of OpenGrok for this repository.
          • $class: 'ViewCVS'
            • url : String
              Specify the root URL of ViewCVS for this repository (such as this).
      • canUseUpdate : boolean
        If checked, Jenkins will use 'cvs update' whenever possible for builds. This makes a build faster. But this also causes the artifacts from the previous build to remain in the file system when a new build starts, making it not a true clean build.
      • legacy : boolean
        Hudson 1.20 and earlier used to create redundant directories inside the workspace. For example, if the CVS module name is "foo/bar", it first created "foo/bar" and then put everything below. With this option checked off, there will be no more such unnecessary intermediate directories.

        If you have multiple modules to check out, this option is forced (otherwise they'll overlap.)

        This affects other path specifiers, such as artifact archivers --- you now specify "build/foo.jar" instead of "foo/build/foo.jar".

      • skipChangeLog : boolean
        Prevent the changelog being generated after checkout has completed. This will stop any changes being shown on the changes screen but reduces load on your CVS server.
      • pruneEmptyDirectories : boolean
        Remove empty directories after checkout using the CVS '-P' option.
      • disableCvsQuiet : boolean
        Instructs CVS to show all logging output. CVS normally runs in quiet mode but this option disables that.
      • cleanOnFailedUpdate : boolean
        If the job is configured to use CVS update and the update step fails for any reason then the workspace will be wiped-out and a clean checkout done instead.
      • forceCleanCopy : boolean
        If checked, Jenkins will add the 'C' option to the CVS update command to force it to over-write any files with local modifications, rather than attempt a merge or leave them as they are.
      • checkoutCurrentTimestamp : boolean
        Advanced option. Should probably be left unchecked.

        The build quiet period is designed to assist with CVS checkouts by waiting for a specific period of time without commits. Normally you want the checkout to reflect the time when the quiet period was exited successfully. Select this option if you need to re-enable the legacy behaviour of Jenkins, i.e. using the time that the build started checking out as the timestamp for the checkout operation. Note: enabling this option can result in the quiet period being defeated especially in those cases where the build is not able to start immediately after exiting the quiet period.

    • 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.