Using Perforce repositories with Sourcegraph
You can use Perforce repositories with Sourcegraph by using the git p4 adapter, which creates an equivalent Git repository from a Perforce repository, and
src serve-git, Sourcegraph’s tool for serving local directories.
Screenshot of using Sourcegraph for code navigation in a Perforce repository:
p4CLI configured to access your Perforce repository
git p4(see “Adding
git p4to an existing install”)
Create an equivalent Git repository and serve it to Sourcegraph
For each Perforce repository you want to use with Sourcegraph, follow these steps:
- Create a local Git repository with the contents of your Perforce repository:
git p4 clone //DEPOT/[email protected](replace
//DEPOT/PATHwith the Perforce repository path).
src serve-gitfrom the parent directory that holds all of the new local Git repositories.
- Follow the instructions in the
src serve-gitQuickstart to add the repositories to your Sourcegraph instance.
Updating Perforce repositories
To update the repository after new Perforce commits are made, run
git p4 sync in the local repository directory. These changes will be automatically reflected in Sourcegraph as long as
src serve-git is running.
We recommend running this command on a periodic basis using a cron job, or some other scheduler. The frequency will dictate how fresh the code is in Sourcegraph, and can range from once every 10s to once per day, depending on how large your codebase is and how long it takes
git p4 sync to complete.
src serve-git: push the new Git repository to a code host
If you prefer, you can skip using
src serve-git, and instead push the new local Git repository to a Git-based code host of your choice. For updates, you would run
git p4 sync && git push periodically.
If you do this, the repositories you created on your Git host are normal Git repositories, so you can add the repositories to Sourcegraph as you would any other Git repositories.
Alternative for extra-large codebases
The instructions below will help you get Perforce repositories on Sourcegraph quickly and easily, while retaining all code change history. If your Perforce codebase is large enough that converting it to Git takes long enough to cause noticeable staleness on Sourcegraph, you can use
src-expose’s optional syncing functionality along with a faster fetching command (like
p4 sync instead of
git p4 sync) to periodically fetch and squash changes without trying to preserve the original Perforce history.
We intend to improve Sourcegraph’s Perforce support in the future. Please file an issue to help us prioritize any specific improvements you’d like to see.
- Sourcegraph was initially built for Git repositories only, so it exposes Git concepts that are meaningless for converted Perforce repositories, such as the commit SHA, branches, and tags.
- The commit messages for a Perforce repository converted to a Git repository have an extra line at the end with Perforce information, such as
[git-p4: depot-paths = "//guest/acme_org/myproject/": change = 12345].