Fork me on GitHub

liquibase:assembleChangeLog

Full name:

com.edugility:liquibase-maven-plugin:1.0.0:assembleChangeLog

Description:

Scans the test classpath in dependency order for Liquibase changelog fragments and assembles a master changelog that includes them all in dependency order.

Attributes:

  • Requires a Maven project to be executed.
  • Requires dependency resolution of artifacts in scope: test.

Required Parameters

Name Type Since Description
changeLogCharacterEncoding String - The character encoding to use while writing the generated changelog; ${project.build.sourceEncoding} by default.
Default value is: ${project.build.sourceEncoding}.
changeLogResourceNames List - A list of classpath resource names that identity Liquibase changelogs; META-INF/liquibase/changelog.xml by default.
Default value is: META-INF/liquibase/changelog.xml.
databaseChangeLogXsdVersion String - The version of the proper XSD file to use that defines the contents of a Liquibase changelog file; 3.0 by default.
Default value is: 3.0.
outputFile File - The full path to the changelog that will be generated; ${project.build.directory}/generated-sources/liquibase/changelog.xml by default.
Default value is: ${project.build.directory}/generated-sources/liquibase/changelog.xml.
templateCharacterEncoding String - The character encoding to use while reading in the changelog MVEL template; ${project.build.sourceEncoding} by default.
Default value is: ${project.build.sourceEncoding}.

Optional Parameters

Name Type Since Description
artifactFilter ArtifactFilter - An ArtifactFilter to use to limit what dependencies are scanned for changelog fragments; null by default.
changeLogParameters Properties - A set of Properties defining changelog parameters; null by default.
changeLogTemplateResourceName String - The classpath resource name of the MVEL template that will be used to aggregate all the changelog fragments together; changelog-template.mvl by default; typically found within this plugin's own .jar file, but users may wish to supply an alternate template.
skip boolean - Whether or not this plugin execution should be skipped; false by default.
Default value is: false.

Parameter Details

artifactFilter:

An ArtifactFilter to use to limit what dependencies are scanned for changelog fragments; null by default.
  • Type: org.apache.maven.artifact.resolver.filter.ArtifactFilter
  • Required: No

changeLogCharacterEncoding:

The character encoding to use while writing the generated changelog; ${project.build.sourceEncoding} by default.
  • Type: java.lang.String
  • Required: Yes
  • Default: ${project.build.sourceEncoding}

changeLogParameters:

A set of Properties defining changelog parameters; null by default.
  • Type: java.util.Properties
  • Required: No

changeLogResourceNames:

A list of classpath resource names that identity Liquibase changelogs; META-INF/liquibase/changelog.xml by default.
  • Type: java.util.List
  • Required: Yes
  • Default: META-INF/liquibase/changelog.xml

changeLogTemplateResourceName:

The classpath resource name of the MVEL template that will be used to aggregate all the changelog fragments together; changelog-template.mvl by default; typically found within this plugin's own .jar file, but users may wish to supply an alternate template.
  • Type: java.lang.String
  • Required: No

databaseChangeLogXsdVersion:

The version of the proper XSD file to use that defines the contents of a Liquibase changelog file; 3.0 by default.
  • Type: java.lang.String
  • Required: Yes
  • Default: 3.0

outputFile:

The full path to the changelog that will be generated; ${project.build.directory}/generated-sources/liquibase/changelog.xml by default.
  • Type: java.io.File
  • Required: Yes
  • Default: ${project.build.directory}/generated-sources/liquibase/changelog.xml

skip:

Whether or not this plugin execution should be skipped; false by default.
  • Type: boolean
  • Required: No
  • Default: false

templateCharacterEncoding:

The character encoding to use while reading in the changelog MVEL template; ${project.build.sourceEncoding} by default.
  • Type: java.lang.String
  • Required: Yes
  • Default: ${project.build.sourceEncoding}