Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/paketo-buildpacks/maven

A Cloud Native Buildpack that builds Maven-based applications from source
https://github.com/paketo-buildpacks/maven

build-system cnb jvm-applications maven

Last synced: 4 days ago
JSON representation

A Cloud Native Buildpack that builds Maven-based applications from source

Host: GitHub
URL: https://github.com/paketo-buildpacks/maven
Owner: paketo-buildpacks
License: apache-2.0
Created: 2020-04-17T19:35:35.000Z (over 4 years ago)
Default Branch: main
Last Pushed: 2024-08-26T12:05:41.000Z (4 months ago)
Last Synced: 2024-08-26T14:20:21.090Z (4 months ago)
Topics: build-system, cnb, jvm-applications, maven
Language: Go
Size: 985 KB
Stars: 30
Watchers: 10
Forks: 13
Open Issues: 4
Metadata Files:
- Readme: README.md
- License: LICENSE
- Codeowners: .github/CODEOWNERS

Awesome Lists containing this project

README

# `gcr.io/paketo-buildpacks/maven`

The Paketo Buildpack for Maven is a Cloud Native Buildpack that builds Maven-based applications from source.

## Behavior

This buildpack will participate if all the following conditions are met:

* Another buildpack requires `maven`, `jvm-application-package` or both
* `/pom.xml` exists or `BP_MAVEN_POM_FILE` is set to an existing POM file.

The buildpack will do the following:

* Requests that a JDK be installed
* Links the `~/.m2` to a layer for caching
* If `/mvnw` does not exist and `mvn` is not on `$PATH`
* Contributes Maven or Maven Daemon to a layer with all commands on `$PATH`
* Runs `/bin/mvn -Dmaven.test.skip=true --no-transfer-progress package` to build the application
* Caches `$BP_MAVEN_BUILT_ARTIFACT` to a layer
* If `/mvnw` exists
* Runs `/mvnw -Dmaven.test.skip=true --no-transfer-progress package` to build the application
* Caches `$BP_MAVEN_BUILT_ARTIFACT` to a layer
* If `mvn` is on `$PATH`
* Runs `mvn -Dmaven.test.skip=true --no-transfer-progress package` to build the application
* Caches `$BP_MAVEN_BUILT_ARTIFACT` to a layer
* Removes the source code in ``, following include/exclude rules
* If `$BP_MAVEN_BUILT_ARTIFACT` matched a single file
* Restores `$BP_MAVEN_BUILT_ARTIFACT` from the layer, expands the single file to ``
* If `$BP_MAVEN_BUILT_ARTIFACT` matched a directory or multiple files
* Restores the files matched by `$BP_MAVEN_BUILT_ARTIFACT` to ``
* If `$BP_JAVA_INSTALL_NODE` is set to true and the buildpack finds one of the following at `` or at the path set by `$BP_NODE_PROJECT_PATH`:
* a `yarn.lock` file, the buildpack requests that `yarn` and `node` are installed at build time
* a `package.json` file, the buildpack requests that `node` is installed at build time

## Configuration

| Environment Variable | Description |
|----------------------------------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
| `$BP_MAVEN_VERSION` | Configure the major Maven version (e.g. `3`, `4`). Since the buildpack only ships a single version of each supported line, updates to the buildpack can change the exact version of Maven installed. If you require a specific minor/patch version of Maven, use the Maven wrapper instead. |
| `$BP_MAVEN_BUILD_ARGUMENTS` | Configure the arguments to pass to Maven. Defaults to `-Dmaven.test.skip=true --no-transfer-progress package`. `--batch-mode` will be prepended to the argument list in environments without a TTY. |
| `$BP_MAVEN_ADDITIONAL_BUILD_ARGUMENTS` | Configure the additionnal arguments (e.g. `-DskipJavadoc`; appended to BP_MAVEN_BUILD_ARGUMENTS) to pass to Maven. Defaults to `` (empty string). |
| `$BP_MAVEN_ACTIVE_PROFILES` | Configure the active profiles (comma separated: e.g. `p1,!p2,?p3`) to pass to Maven. Defaults to `` (empty string). |
| `$BP_MAVEN_BUILT_MODULE` | Configure the module to find application artifact in. Defaults to the root module (empty). |
| `$BP_MAVEN_BUILT_ARTIFACT` | Configure the built application artifact explicitly. Supersedes `$BP_MAVEN_BUILT_MODULE` Defaults to `target/*.[ejw]ar`. Can match a single file, multiple files or a directory. Can be one or more space separated patterns. |
| `$BP_MAVEN_POM_FILE` | Specifies a custom location to the project's `pom.xml` file. It should be a full path to the file under the `/workspace` directory or it should be relative to the root of the project (i.e. `/workspace'). Defaults to `pom.xml`. |
| `$BP_MAVEN_DAEMON_ENABLED` | Triggers apache maven-mvnd to be installed and configured for use instead of Maven. The default value is `false`. Set to `true` to use the Maven Daemon. |
| `$BP_MAVEN_SETTINGS_PATH` | Specifies a custom location to Maven's `settings.xml` file. If `$BP_MAVEN_SETTINGS_PATH` is set and a Maven binding is provided, the binding takes the higher precedence. |
| `$BP_INCLUDE_FILES` | Colon separated list of glob patterns to match source files. Any matched file will be retained in the final image. Defaults to `` (i.e. nothing). |
| `$BP_EXCLUDE_FILES` | Colon separated list of glob patterns to match source files. Any matched file will be specifically removed from the final image. If include patterns are also specified, then they are applied first and exclude patterns can be used to further reduce the fileset. |
| `$BP_JAVA_INSTALL_NODE` | Configure whether to request that `yarn` and `node` are installed by another buildpack**. If set to `true`, the buildpack will check the app root or path set by `$BP_NODE_PROJECT_PATH` for either: A `yarn.lock` file, which requires that `yarn` and `node` are installed or, a `package.json` file, which requires that `node` is installed. Defaults to `false` |
| `$BP_NODE_PROJECT_PATH` | Configure a project subdirectory to look for `package.json` and `yarn.lock` files |

### Note
** If the node and/or yarn requirements are met and the [Node Engine](https://github.com/paketo-buildpacks/node-engine) or [Yarn](https://github.com/paketo-buildpacks/yarn) participate in the build, environment variables related to these buildpacks can be set, such as `BP_NODE_PROJECT_PATH` or `BP_NODE_VERSION`. See the [Paketo Node.js docs](https://paketo.io/docs/howto/nodejs/) for more info.

## Bindings

The buildpack optionally accepts the following bindings:

### Type: `maven`

| Secret | Description |
| ----------------------- | ------------------------------------------------------------------------------------------------------ |
| `settings.xml` | If present `--settings=` is prepended to the `maven` arguments |
| `settings-security.xml` | If present `-Dsettings.security=` is prepended to the `maven` arguments |

### Type: `dependency-mapping`

| Key | Value | Description |
| --------------------- | ------- | ------------------------------------------------------------------------------------------------- |
| `` | `` | If needed, the buildpack will fetch the dependency with digest `` from `` |

## License

This buildpack is released under version 2.0 of the [Apache License][a].

[a]: http://www.apache.org/licenses/LICENSE-2.0