Skip to content

Commit 2413332

Browse files
authored
Merge pull request #16802 from github/smowton/admin/note-java-system-requirements
Java: document extraction system requirements
2 parents 8dc95ce + cfb48ac commit 2413332

File tree

1 file changed

+7
-0
lines changed

1 file changed

+7
-0
lines changed

docs/codeql/codeql-overview/system-requirements.rst

+7
Original file line numberDiff line numberDiff line change
@@ -43,3 +43,10 @@ For Python extraction:
4343
For Ruby extraction:
4444

4545
- On Windows, the ``msvcp140.dll`` must be installed and available on the system. This can be installed by downloading the appropriate Microsoft Visual C++ Redistributable for Visual Studio.
46+
47+
For Java extraction:
48+
49+
- There must be a ``java`` or ``java.exe`` executable available on the ``PATH``, and the ``JAVA_HOME`` environment variable must point to the corresponding JDK's home directory.
50+
- If you need to analyse projects using varying JDK versions, it may be useful to supply alternate JDK versions using environment variables of the form ``JAVA_HOME_$VERSION_$PLATFORM``, following the example of `the GitHub Actions runner images <https://github.com/actions/runner-images/blob/main/images/ubuntu/Ubuntu2404-Readme.md#java>`__. An Apache Maven `toolchains.xml file <https://maven.apache.org/guides/mini/guide-using-toolchains.html#using-toolchains-in-your-project>`__ can also be used for the same purpose.
51+
- Having a ``mvn`` or ``mvn.exe`` executable available on the ``PATH`` is recommended if your project uses Apache Maven and does not use the ``mvnw`` wrapper script.
52+
- Having a ``gradle`` or ``gradle.exe`` executable available on the ``PATH`` is recommended if your project uses Gradle and does not use the ``gradlew`` wrapper script.

0 commit comments

Comments
 (0)