Interface VersionControlSpec

All Superinterfaces:
Describable
All Known Subinterfaces:
GitVersionControlSpec

@Incubating public interface VersionControlSpec extends Describable
Captures user-provided information about a version control system.
Since:
4.4
  • Method Summary

    Modifier and Type
    Method
    Description
    Returns the name of the repository.
    Returns the relative path to the root of the build within the repository.
    Returns a String identifier which will be unique to this version control specification among other version control specifications.
    void
    setRootDir(String rootDir)
    Sets the relative path to the root of the build within the repository.

    Methods inherited from interface Describable

    getDisplayName
  • Method Details

    • getUniqueId

      String getUniqueId()
      Returns a String identifier which will be unique to this version control specification among other version control specifications.
    • getRepoName

      String getRepoName()
      Returns the name of the repository.
    • getRootDir

      String getRootDir()
      Returns the relative path to the root of the build within the repository.

      Defaults to an empty relative path, meaning the root of the repository.

      Since:
      4.5
    • setRootDir

      void setRootDir(String rootDir)
      Sets the relative path to the root of the build within the repository.
      Since:
      4.5