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: 'MercurialSCM'

  • $class: 'MercurialSCM'
    • source : String
      Specify the repository to track. This can be URL or a local file path. If you are specifying HTTP credentials, do not include a username in the URL.
    • browser (optional)
        Nested Choice of Objects
      • $class: 'FishEye'
        • url : String
          Specify the root URL serving this repository, such as: http://www.example.org/browse/hg/
      • $class: 'GoogleCode'
        • url : String
          Specify the root URL serving this repository (such as this).
      • $class: 'HgWeb'
        • url : String
          Specify the root URL serving this repository (such as this).
      • $class: 'Kallithea'
        • url : String
          Specify the root URL serving this repository (such as this).
      • $class: 'KilnHG'
        • url : String
          Specify the root URL serving this repository (such as this).
      • $class: 'RhodeCode'
        • url : String
          Specify the root URL serving this repository (such as this).
      • $class: 'RhodeCodeLegacy'
        • url : String
          Specify the root URL serving this repository (such as this).
      • $class: 'ScmManager'
        • url : String
          Specify the root URL serving this repository (such as http://YOURSCMMANAGER/scm/repo/NAMESPACE/NAME/).
    • clean : boolean (optional)
      When this option is checked, each build will wipe any local modifications or untracked files in the repository checkout. This is often a convenient way to ensure that a build is not using any artifacts from earlier builds.
    • credentialsId : String (optional)
      Optional credentials to use when cloning or pulling from the remote repository. Supports username/password with HTTP(S) URLs, and SSH private key with SSH URLs.
    • disableChangeLog : boolean (optional)
      When checked, Hudson will not calculate the Mercurial changelog for each build. Disabling the changelog can decrease the amount of time needed to update a very large repository.
    • installation : String (optional)
    • modules : String (optional)
      Reduce unnecessary builds by specifying a comma or space delimited list of "modules" within the repository. A module is a directory name within the repository that this project lives in. If this field is set, changes outside the specified modules will not trigger a build (even though the whole repository is checked out anyway due to the Mercurial limitation.)
    • revision : String (optional)
      Specify the branch or tag name you would like to track. (If you do not type anything, the default value is the default branch.)
    • revisionType (optional)
      Specify the kind of revision you expect Jenkins to update your working copy to.
      • Values: BRANCH, TAG, CHANGESET, REVSET
    • subdir : String (optional)
      If not empty, check out the Mercurial repository into this subdirectory of the job's workspace. For example: my/sources (use forward slashes). If changing this entry, you probably want to clean the workspace first.

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