Package org.gradle.vcs

Interface VersionControlSpec

All Superinterfaces:
Describable
All Known Subinterfaces:
GitVersionControlSpec
public interface VersionControlSpec extends Describable
Captures user-provided information about a version control repository.
Since:
4.4

  • Method Details

    • getUniqueId

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

    • getRepoName

      Provider<String> getRepoName()
      Returns the name of the repository.

    • getRootDir

      Property<String> getRootDir()
      The relative path to the root of the build within the repository.

      An empty string means the root of the repository (this is the default value).

      Returns:
      the root directory of the build, relative to the root of this repository.
      Since:
      4.5

    • setRootDir

      void setRootDir(String rootDir)
      Sets the relative path to the root of the build within the repository. Use an empty string to refer to the root of the repository.
      Parameters:
      rootDir - The root directory of the build, relative to the root of this repository.
      Since:
      4.5

    • plugins

      void plugins(Action<? super InjectedPluginDependencies> configuration)
      Configure injected plugins into this build.
      Parameters:
      configuration - the configuration action for adding injected plugins
      Since:
      4.6