VCS Repositories

VCS repositories require an appropriate repository layout to support a more hierarchical layout of the cached items.

To use a hierarchical layout for your repository, you can either use the built-in vcs-default layout that comes with Artifactory out-of-the-box, or define a Custom Layout. This will ensure that different maintenance features like Version Cleanup will work correctly.

Integration Benefits JFrog Artifactory and Git

Below is an example of a Custom Layout named vcs-default:

You can configure the Custom Layout, or simply copy the below code snippet into the relevant section in the Administration module, under Repository Management | Layouts.

<repoLayout>
        <name>vcs-default</name>
    <artifactPathPattern>[orgPath]/[module]/[refs<tags|branches>]/[baseRev]/[module]-[baseRev](-[fileItegRev])(-[classifier]).[ext]</artifactPathPattern>
    <distinctiveDescriptorPathPattern>false</distinctiveDescriptorPathPattern>
    <folderIntegrationRevisionRegExp>.*</folderIntegrationRevisionRegExp>
    <fileIntegrationRevisionRegExp>[a-zA-Z0-9]{40}</fileIntegrationRevisionRegExp>
</repoLayout>

If a repository package layout is in a corresponding folder hierarchy, the Artifactory Version Cleanup tool correctly detects previously installed versions.

Searching for artifact versions using the REST API also works properly:

$ curl "http://localhost:8081/artifactory/api/search/versions?g=jquery&a=jquery&repos=github-cache"
{
        "results" : [ {
                "version" : "2.0.3",
                "integration" : false
        }, {
                "version" : "master-062b5267d0a3538f1f6dee3df16da536b73061ea",
                "integration" : true
        } ]
}

You need to create a Remote Repository which serves as a caching proxy for github.com. If necessary, you can do the same for bitbucket.org or any other remote git repository that you need.

Artifacts (such as tar.gz files) requested from a remote repository are cached on demand. You can remove downloaded artifacts from the remote repository cache, however, you can not manually deploy artifacts to a remote repository.

To create a remote repository to proxy github.com or an self-hosted GitHub Enterprise repository, follow the steps below:

Git Providers

Artifactory supports proxying the following Git providers out-of-the-box: GitHub, Bitbucket, Stash, a remote Artifactory instance or a custom Git repository as displayed below:

Use the custom provider if you have a Git repository which does not exist in the pre-defined list. In this case, you need to provide Artifactory with the download paths for your Git tarballs.

You do so by providing 4 placeholders:

Placeholder	Description
{0}	Identifies the username or organization name.
{1}	Identifies the repository name.
{2}	Identifies the branch or tag name.
{3}	Identifies the file extension to download.

For example, GitHub exposes tarball downloads at: https://github.com/<user>/<repo>/archive/<tag/branch>.<extension>

Therefore, the custom download path configured for Artifactory should be {0}/{1}/archive/{2}.{3}