compose:link

Full name:

org.honton.chas:compose-maven-plugin:0.0.18:link

Description:

Link compose configuration into single application

Attributes:

  • Requires a Maven project to be executed.
  • The goal is thread-safe and supports parallel builds.
  • Binds by default to the lifecycle phase: test.

Required Parameters

Name Type Since Description
<project> String - Compose project name
Default value is: ${project.artifactId}.
User property is: compose.project.

Optional Parameters

Name Type Since Description
<cli> String - docker compose command line interface
Default value is: docker-compose.
User property is: compose.cli.
<dependencies> List<String> - Dependencies in `Group:Artifact:Version` or `Group:Artifact::Classifier:Version` form
<filter> boolean - Interpolate compose configuration with values from maven build properties
Default value is: true.
User property is: compose.filter.
<skip> boolean - Skip compose goal
Default value is: false.
User property is: compose.skip.
<source> String - Directory which holds compose application configuration(s). Compose files should be in subdirectories to namespace the configuration.
Default value is: ${project.basedir}/src/main/compose.
User property is: compose.source.
<timeout> int - Number of seconds to wait for compose commands
Default value is: 90.
User property is: compose.timeout.

Parameter Details

<cli>

docker compose command line interface
  • Type: java.lang.String
  • Required: No
  • User Property: compose.cli
  • Default: docker-compose

<dependencies>

Dependencies in `Group:Artifact:Version` or `Group:Artifact::Classifier:Version` form
  • Type: java.util.List<java.lang.String>
  • Required: No

<filter>

Interpolate compose configuration with values from maven build properties
  • Type: boolean
  • Required: No
  • User Property: compose.filter
  • Default: true

<project>

Compose project name
  • Type: java.lang.String
  • Required: Yes
  • User Property: compose.project
  • Default: ${project.artifactId}

<skip>

Skip compose goal
  • Type: boolean
  • Required: No
  • User Property: compose.skip
  • Default: false

<source>

Directory which holds compose application configuration(s). Compose files should be in subdirectories to namespace the configuration.
  • Type: java.lang.String
  • Required: No
  • User Property: compose.source
  • Default: ${project.basedir}/src/main/compose

<timeout>

Number of seconds to wait for compose commands
  • Type: int
  • Required: No
  • User Property: compose.timeout
  • Default: 90