Skip to content
Merged
Show file tree
Hide file tree
Changes from 1 commit
Commits
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
Prev Previous commit
Next Next commit
docs: Add toolchains.xml example and setup guide
  • Loading branch information
fabisev committed Jul 15, 2026
commit 3bdc9511c1cb6b56ad0d23d85a9f71c8d1d762b5
19 changes: 19 additions & 0 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -36,6 +36,25 @@ To send us a pull request, please:
5. Send us a pull request, answering any default questions in the pull request interface.
6. Pay attention to any automated CI failures reported in the pull request, and stay involved in the conversation.


## Build Prerequisites

This project uses the Maven Toolchains Plugin to pin compilation to JDK 8. If you don't have a `~/.m2/toolchains.xml` configured, builds will fail with:

```
No toolchain found for type jdk [ version='[1.8,9)' ]
```

To fix this, copy the example file to your Maven config directory and update the path:

```bash
cp toolchains.xml.example ~/.m2/toolchains.xml
```

Then edit `~/.m2/toolchains.xml` and set `<jdkHome>` to your local JDK 8 installation path.

Note: if you use `actions/setup-java` in CI (as our GitHub Actions workflows do), this file is generated automatically.

GitHub provides additional document on [forking a repository](https://help.github.com/articles/fork-a-repo/) and
[creating a pull request](https://help.github.com/articles/creating-a-pull-request/).

Expand Down
21 changes: 21 additions & 0 deletions toolchains.xml.example
Original file line number Diff line number Diff line change
@@ -0,0 +1,21 @@
<?xml version="1.0" encoding="UTF-8"?>
<!--
Maven Toolchains configuration for aws-lambda-java-libs.

This file tells Maven where to find JDK 8, which is required by the
maven-toolchains-plugin configured in each module's pom.xml.

To use: copy this file to ~/.m2/toolchains.xml and set the jdkHome
path to match your local JDK 8 installation.
-->
<toolchains>
<toolchain>
<type>jdk</type>
<provides>
<version>8</version>
</provides>
<configuration>
<jdkHome>/path/to/your/jdk8</jdkHome>
</configuration>
</toolchain>
</toolchains>
Loading