Skip to content

docs: requirements file support for maven plugin #568

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

Open
ih0r-d wants to merge 2 commits into
base: master
Choose a base branch
from
Open

docs: requirements file support for maven plugin #568

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
5fe9e0d
docs: requirements file support for maven plugin
ih0r-d Nov 25, 2025
35ef0dc
docs: update requirements file description to indicate no lock-file a…
ih0r-d Dec 3, 2025
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
17 changes: 17 additions & 0 deletions docs/user/Embedding-Build-Tools.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -148,6 +148,23 @@ The Python packages and their versions are specified as if used with `pip`:
...
</configuration>
```
- The **requirementsFile** element declares a path to a pip-compatible `requirements.txt` file.
The plugin forwards this file directly to pip (`pip install -r`), allowing full use of pip’s native dependency format.

```xml
<configuration>
<requirementsFile>requirements.txt</requirementsFile>
...
</configuration>
```

> **_NOTE:_**
> Exactly one of `packages` or `requirementsFile` must be configured.
> When `requirementsFile` is used:
> - the GraalPy lock file is not created or used
> - the `lock-packages` goal is disabled
> - dependency locking must be handled by pip (e.g., `pip freeze`)


- The **resourceDirectory** element can specify the relative [Java resource path](#java-resource-path).
Remember to use `VirtualFileSystem$Builder#resourceDirectory` when configuring the `VirtualFileSystem` in Java.
Expand Down