Skip to content

feat/docs: Add explanation for cross-repository navigation #853

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
pjlast merged 1 commit into from
Mar 9, 2026
Merged

feat/docs: Add explanation for cross-repository navigation #853

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
18 changes: 18 additions & 0 deletions docs/getting-started.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -152,6 +152,8 @@ libraryDependencies += "com.sourcegraph" %% "scip-java" % "@STABLE_VERSION@"
> [Supported build tools](#supported-build-tools) for more details about other
> build tools.

> For cross-repository navigation, additional dependency metadata is required (for Gradle, enable `maven-publish`); see [Cross-Repository Navigation (Optional)](#cross-repository-navigation-optional).

Run the `scip-java index` command to generate a SCIP index for your codebase.
This command should automatically infer the structure of your codebase and
configure your build tool to generate SCIP.
Expand Down Expand Up @@ -180,6 +182,22 @@ scip-java index -- --batch-mode -DskipTests package

The `index.scip` file contains the SCIP index and is ready to be used.

### Cross-Repository Navigation (Optional)

By default, `scip-java index` enables navigation within the local repository.
To enable cross-repository navigation, `scip-java` needs dependency metadata
from your build.

For Gradle builds, this requires enabling `maven-publish` and defining a Maven
publication (for example, from `components["java"]`) in `build.gradle` or
`build.gradle.kts`.

If this is not configured, indexing may still succeed, but cross-repository
definitions/references may not resolve.

See [Manual configuration: Step 4 (optional): Enable cross-repository navigation](manual-configuration.md#step-4-optional-enable-cross-repository-navigation)
for detailed setup options.

> Running `scip-java index` may perform side-effects on your build like cleaning
> the compile cache before indexing. This is done to make sure that all source
> files in the codebase get indexed.
Expand Down