Expansion Options

The expansionSettings.xml also allows you to add options to configure the expandersExpanderA unit of generation that combines a data tree instance (functional M1 model) with a template to generate an artifact..

Option

dryRun ExpansionSettings

Run the expansion, but do not generate any files

<options>
  <dryRun/>
</options>

Option

cleanExpansion ExpansionSettings

Always clean expansion directory before expansion

<options>
  <cleanExpansion/>
</options>

Filtering Expanders, Features and ExpansionSteps

Expander Filters

These options can be a powerful tool to disable specific ExpandersExpanderA unit of generation that combines a data tree instance (functional M1 model) with a template to generate an artifact. or to only run a specific set of ExpandersExpanderA unit of generation that combines a data tree instance (functional M1 model) with a template to generate an artifact.. However, they should be used with care, since they leave the burden of creating a correct set of expanded artifactsArtifactA build or deployment result, such as a Docker container image or Java archive, produced by a software project. with the developer.

Option

excludeExpanders ExpansionSettings

Exclude ExpandersExpanderA unit of generation that combines a data tree instance (functional M1 model) with a template to generate an artifact. using a glob pattern

<options>
  <excludeExpanders>net.democritus.expander.struts*</excludeExpanders>
</options>

<options>
  <excludeExpanders>*BeanExpander</excludeExpanders>
</options>

Option

includeExpanders ExpansionSettings

Include ExpandersExpanderA unit of generation that combines a data tree instance (functional M1 model) with a template to generate an artifact. using a glob pattern

<options>
  <includeExpanders>net.democritus.expander*</includeExpanders>
</options>

<options>
  <includeExpanders>*DetailsExpander</includeExpanders>
</options>

Option

excludeFeatures ExpansionSettings

Exclude Features using a glob pattern

<options>
  <excludeFeatures>net.democritus.expander.dataElement.modificationFlags*</excludeFeatures>
</options>

<options>
  <excludeFeatures>*</excludeFeatures>
</options>

Option

excludeExpansionSteps ExpansionSettings

Exclude AdditionalExpansionSteps using a glob pattern

<options>
  <excludeExpansionSteps>net.democritus.expander.harvest*</excludeExpansionSteps>
</options>

<options>
  <excludeExpansionSteps>*</excludeExpansionSteps>
</options>

Skip Phases

Option

skipPhase ExpansionSettings

Skip expansion phases using a glob pattern.

<options>
  <skipPhase>overlay</skipPhase>
</options>

Harvest

It is possible to change the harvest behavior of the expandersExpanderA unit of generation that combines a data tree instance (functional M1 model) with a template to generate an artifact. with the following options. These are mainly useful when developing shared Components.

Option

harvest.force ExpansionSettings

Harvest every artifactArtifactA build or deployment result, such as a Docker container image or Java archive, produced by a software project., ignoring exclusions like base-components.

<options>
  <harvest.force/>
</options>

Option

harvest.modelDirectory.override ExpansionSettings

Change target harvest directory to a specific target model-directory.

<options>
  <harvest.modelDirectory.override>/some/location/</harvest.modelDirectory.override>
</options>

ArtifactWriter

Option

artifactWriter ExpansionSettings

Overwrite the ArtifactWriter used by the ExpandersExpanderA unit of generation that combines a data tree instance (functional M1 model) with a template to generate an artifact. with another class. The class should implement net.democritus.expander.ArtifactWriter.

<options>
  <artifactWriter>org.example.MyArtifactWriter</artifactWriter>
</options>

Feature Tracing

Option

expanders.traceFeatures ExpansionSettings

Add comments around each feature segment linking it to its Feature.

<options>
  <expanders.traceFeatures/>
</options>