Commit e8dc926f authored by Tobias Jeger's avatar Tobias Jeger

ARCHE-551 Add README to repository-data module

parent b588435a
......@@ -61,6 +61,7 @@
<directory>repository-data</directory>
<includes>
<include>pom.xml</include>
<include>README.txt</include>
</includes>
</fileSet>
<!-- repository-data-config module -->
......
......@@ -292,8 +292,8 @@
<profile>
<!-- additional profile to combine with cargo:run to *not* bootstrap the development module:
$ mvn -P cargo.run,without-development -->
<id>without-development</id>
$ mvn -P cargo.run,without-development-data -->
<id>without-development-data</id>
<properties>
<development-module-deploy-dir>temp</development-module-deploy-dir>
</properties>
......
Intent of repository data submodules
====================================
The repository-data module contains all definitions to be bootstrapped into the repository.
It is sub-divided into three sub-modules:
1) application
2) development
3) webfiles
Repository data vital to the application (i.e. which should be bootstrapped into any environment)
should go into the *application* module. In fresh projects, the auto-export mechanism is configured
such that all exported repository-data is added to the application submodule.
Repository data intended for development environments only (i.e. local or CI environments) should
go into the *development* module. By default, this module is available to the bootstrapping mechanism
when deploying the application locally (-Pcargo.run), but not included when building a distribution
(-Pdist). In order to include the development module in a distribution, build it with
-Pdist-with-development-data. You can add repository data into the development module by moving YAML
sources, or by configuring auto-export to export certain repository paths to the development module.
The *webfiles* module is intended to contribute webfiles (only) to the repository data. Like the
application module, it is intended to be included on every environment.
If your application requires so, you can create more repository-data submodules to be deployed to the
environments of your liking, similar to above described default setup.
\ No newline at end of file
<assembly xmlns="http://maven.apache.org/plugins/maven-assembly-plugin/assembly/1.1.2"
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
xsi:schemaLocation="http://maven.apache.org/plugins/maven-assembly-plugin/assembly/1.1.2 http://maven.apache.org/xsd/assembly-1.1.2.xsd">
<id>distribution-with-content</id>
<id>distribution-with-development-data</id>
<formats>
<format>tar.gz</format>
</formats>
......
Markdown is supported
0% or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment