Skip to content

Clarify what files are needed for Gradle and Maven builds #438

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
merged 1 commit into from
May 5, 2022
Merged

Clarify what files are needed for Gradle and Maven builds #438

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
21 changes: 17 additions & 4 deletions docs/getting-started.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -12,8 +12,9 @@ tools that we're planning to support in the future.
## Install `lsif-java`

The most common way to use `lsif-java` is to run it from CI to upload LSIF
indexes after merging a pull request. The easiest way to install `lsif-java` is
to use the Docker launcher.
indexes after merging a pull request.

The easiest way to install `lsif-java` is to use the Docker launcher.

### Docker container

Expand Down Expand Up @@ -259,7 +260,15 @@ on how to configure lsif-java to work with any build tool.
### Gradle

The `lsif-java index` build should be able to automatically index most Gradle
projects. However, the following Gradle integrations are not yet supported:
projects. You Gradle build must contain one of the following files in the same
directory where `lsif-java index` gets invoked.

- settings.gradle
- gradlew
- build.gradle
- build.gradle.kts

The following Gradle integrations are not yet supported:

| Integration | Supported | Tracking issue |
| ----------- | --------- | -------------------------------------------------------------------------------- |
Expand All @@ -270,7 +279,10 @@ projects. However, the following Gradle integrations are not yet supported:
### Maven

The `lsif-java index` build should be able to automatically index most Maven
projects. However, the following Maven integrations are not yet supported:
projects. Your Maven build must contain a `pom.xml` file in the same directory
where `lsif-java index` gets invoked.

The following Maven integrations are not yet supported:

| Integration | Supported | Tracking issue |
| ------------------- | --------- | -------------------------------------------------------------------------------- |
Expand All @@ -286,3 +298,4 @@ projects, with the following caveats:
| Integration | Supported | Recommendation |
| ------------- | --------- | ----------------------- |
| sbt <v0.13.17 | ❌ | Upgrade to sbt v0.13.17 |