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
wants to merge 1 commit 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
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
13 changes: 13 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,19 @@ 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 file with third-party Python packages to be downloaded and installed by the plugin. <br/>Each line in the file is interpreted the same way as by `pip install -r`:

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

> **_NOTE:_**
> Exactly one of `packages` or `requirementsFile` must be configured.
> If both are present at the same time, the build will fail with a configuration error.


- 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