SCM URLs
The <connection>, <developerConnection> and <url> elements of the <scm> section of the POM tell Maven and its plugins where a project's sources live. The connection elements hold an SCM URL, which Maven SCM parses to find the provider that talks to the version control system. This page describes the URL syntax and the SCM URL each of the standard providers expects. The provider's own configuration is described on the Maven SCM site.
SCM URL format
The general format of an SCM URL is
scm:<provider id><delimiter><provider-specific part>
The delimiter is either a colon (:) or a pipe (|). Use the pipe if one of the variables contains a colon, for example a Windows path.
Provider IDs may be remapped with the plugin parameter providerImplementations, supported by both maven-release-plugin and maven-scm-plugin.
Supported SCMs
The following providers ship with Maven SCM.
| SCM | Provider ID | Provider module | Native Java |
|---|---|---|---|
| Git | git |
Git Executable Provider | no |
| Git | jgit |
JGit Provider | yes |
| Subversion | svn |
SVN Executable Provider | no |
| Mercurial | hg |
Mercurial (Hg) Provider | no |
| Local | local |
Local Provider | yes |
A third-party provider, maven-scm-provider-svnjava, is a native Java Subversion provider based on SVNKit.
See also the comparison of revision control software and the common vocabulary of source code management.
The examples below use a colon as the delimiter.
Git
The Git providers (git and jgit) accept the following URLs. The separator for the port is always a colon, because that part is specified in the Git URL specification.
scm:git:git://server_name[:port]/path_to_repository
scm:git:http://server_name[:port]/path_to_repository
scm:git:https://server_name[:port]/path_to_repository
scm:git:ssh://server_name[:port]/path_to_repository
scm:git:file://[hostname]/path_to_repository
The SSH protocol also has an SCP-like syntax in which the protocol is left out:
scm:git:[<user>@]<host>:/<path-to-git-repo>
GitHub proposes this form by default, without the leading slash:
scm:git:[<user>@]<host>:<path-to-git-repo>
For example:
scm:git:git://github.com/path_to_repository
scm:git:http://github.com/path_to_repository
scm:git:https://github.com/path_to_repository
scm:git:git@github.com:path_to_repository
scm:git:ssh://github.com/path_to_repository
scm:git:file://localhost/path_to_repository
Different fetch and push URLs
Sometimes read and write operations need different URLs, for example when fetching works over HTTP but pushing requires SSH. In that case, write both URLs into the <developerConnection> element, with the fetch URL prefixed by [fetch=] and the push URL prefixed by [push=]:
<developerConnection>scm:git:[fetch=]http://mywebserver.org/path_to_repository[push=]ssh://username@otherserver:8898/~/repopath.git</developerConnection>
Further Git provider behavior and its configuration are described on the Maven SCM Git page.
Subversion
The svn provider accepts the following URLs:
scm:svn:svn://[username[:password]@]server_name[:port]/path_to_repository
scm:svn:svn+ssh://[username@]server_name[:port]/path_to_repository
scm:svn:file://[hostname]/path_to_repository
scm:svn:http://[username[:password]@]server_name[:port]/path_to_repository
scm:svn:https://[username[:password]@]server_name[:port]/path_to_repository
For example:
scm:svn:file:///svn/root/module
scm:svn:file://localhost/path_to_repository
scm:svn:file://my_server/path_to_repository
scm:svn:http://svn.apache.org/svn/root/module
scm:svn:https://username@svn.apache.org/svn/root/module
scm:svn:https://username:password@svn.apache.org/svn/root/module
The provider configuration is described on the Maven SCM Subversion page.
Mercurial
The hg provider takes the path or URL of the branch location. The supported protocols are HTTP, HTTPS and FILE, as well as a local path.
scm:hg:url_to_repository/local_repository_directory
For example:
scm:hg:http://host/v3
scm:hg:file://C:/dev/project/v3 (windows drive)
scm:hg:file:///home/smorgrav/dev/project/v3 (linux drive)
scm:hg:/home/smorgrav/dev/project/v3 (local directory)
Local file system
The local provider reads from a directory and has no server. Its URL has this form:
scm:local<delimiter>path_to_repository<delimiter>module_name
path_to_repository: the absolute or relative path to the parent directory of yourpom.xml.module_name: the name of the directory that contains yourpom.xml.
For example:
scm:local:/usr/modules:my_module
scm:local|C:/javaprojects|my_module