Commit 0a1dae63 authored by Brian Long's avatar Brian Long
Browse files

v1.1.x

parent 85746699

README.md

+7 −58
Original line number Diff line number Diff line
@@ -10,64 +10,13 @@ The sole purpose of this project is to build all the submodule components. It i 


### Configuration



There are a couple configurations required to use the components of the BeeDK.  Those are covered in the sections below.



#### Plugin Repository



First, you will need define a reference to the repository for the BeeDK tiles.  This is the case until they find their way into the Maven Central Repository.



You will need to define a plugin repository in your `setting.xml` or your project `pom.xml`.  The following snippet is meant to be included in your `~/.m2/settings.xml` file.



> If you choose to include it in your project `pom.xml`, ignore the structure outside the `pluginRepositories` element and place that element directly under the `project` element.



```xml

<settings ...>

	...

	<profiles>

		...

		<profile>

			<id>inteligr8</id>

			<pluginRepositories>

				<pluginRepository>

					<id>inteligr8-public</id>

					<url>http://repos.inteligr8.com/nexus/repository/inteligr8-public</url>

				</pluginRepository>

			</pluginRepositories>

		</profile>

		...

	</profiles>

	...

</settings>

```

There is no extra configuration required to use the BeeDK or its modules.  Some modules may require tools like Docker, but those are requirements of the module, not the BeeDK.



#### Archetype



Next, you will need to configure using a repository not named Maven Central for archetypes.  Defining a location for archetypes is incredibly bug-laden in the Maven Archetype plugin framework.  The only good way to achieve it is by defining an alternative `settings.xml` file.  So create a new file called `.m2/beedk-settings.xml` with the following contents.



```xml

<settings xmlns="http://maven.apache.org/SETTINGS/1.0.0"

		xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"

		xsi:schemaLocation="http://maven.apache.org/SETTINGS/1.0.0 https://maven.apache.org/xsd/settings-1.0.0.xsd">

	<profiles>

		<profile>

			<id>custom-archetype</id>

			<repositories>

				<repository>

					<id>archetype</id>

					<url>http://repos.inteligr8.com/nexus/repository/inteligr8-public</url>

				</repository>

			</repositories>

		</profile>

	</profiles>

	<activeProfiles>

		<activeProfile>custom-archetype</activeProfile>

	</activeProfiles>

</settings>

```

The BeeDK official artifacts are all deployed to Maven Central.  There are no 3rd party repositories needed.  You may develop and deploy your own extensions in other repositories though.  In those cases, the repositories will need to be defined as `pluginRepositories` in order for Maven Tiles to use them during its discovery.



### Components

### Modules



The following components are useful to users of the BeeDK.

The following tiles (side-loaded components) are useful to users of the BeeDK.  BeeDK makes extensive use of [Maven Tiles](https://github.com/repaint-io/maven-tiles).



#### Public API
@@ -75,8 +24,8 @@ The following components are useful to users of the BeeDK. 
| ------------------------------------- | ------------- | ------- |

| `beedk-acs-platform-module-tile`      | [Source](/inteligr8/ootbee-beedk/src/stable/beedk-acs-platform-module-tile)      | Intended to be inherited by all Alfresco Platform module projects; Includes ampification and more. |

| `beedk-acs-share-module-tile`         | [Source](/inteligr8/ootbee-beedk/src/stable/beedk-acs-share-module-tile)         | Intended to be inherited by all Alfresco Share module projects; Includes ampification, JS compression, and more. |

| `beedk-acs-platform-webapp-tile`      | [Source](/inteligr8/ootbee-beedk/src/stable/beedk-acs-platform-webapp-tile)      | Intended to be inherited by all Alfresco Platform web application projects; Includes installing AMPs, and more. |

| `beedk-acs-share-webapp-tile`         | [Source](/inteligr8/ootbee-beedk/src/stable/beedk-acs-share-webapp-tile)         | Intended to be inherited by all Alfresco Share web application projects; Includes installing AMPs, and more. |

| `beedk-acs-platform-webapp-tile`      | [Source](/inteligr8/ootbee-beedk/src/stable/beedk-acs-platform-webapp-tile)      | Intended to be inherited by all Alfresco Platform web application projects; Includes installing AMPs, loading JARs, and more. |

| `beedk-acs-share-webapp-tile`         | [Source](/inteligr8/ootbee-beedk/src/stable/beedk-acs-share-webapp-tile)         | Intended to be inherited by all Alfresco Share web application projects; Includes installing AMPs, loading JARs, and more. |

| `beedk-ate-springboot`                | [Source](/inteligr8/ootbee-beedk/src/stable/beedk-ate-springboot) | Intended to be inherited by all Alfresco Transform Engine Spring Boot projects; Includes dependencies. |

| `beedk-ate-springboot-test`           | [Source](/inteligr8/ootbee-beedk/src/stable/beedk-ate-springboot-test) | Intended to be inherited by all Alfresco Transform Engine Spring Boot projects; Includes dependencies. |

| `beedk-ate-springboot-tile`           | [Source](/inteligr8/ootbee-beedk/src/stable/beedk-ate-springboot-tile) | Intended to be inherited by all Alfresco Transform Engine Spring Boot projects; Includes Spring Boot repackaging and more. |
@@ -169,7 +118,7 @@ docker container ls -aq --filter={artifactId}-* | % { docker container rm $_ } 
You can use one of these Maven Archetypes to generate a new project by executing the following at the command line.



```sh

mvn -s ~/.m2/beedk-settings.xml archetype:generate

mvn archetype:generate

```



### Scaffolding

beedk-acs-allinone-archetype/pom.xml

+1 −1
Original line number Diff line number Diff line
@@ -10,7 +10,7 @@ 
	<parent>

		<groupId>com.inteligr8.ootbee</groupId>

		<artifactId>beedk-parent</artifactId>

		<version>1.0-SNAPSHOT</version>

		<version>1.1-SNAPSHOT</version>

		<relativePath>..</relativePath>

	</parent>

beedk-acs-lts-it-tile/README.md

+1 −8
Original line number Diff line number Diff line
@@ -52,19 +52,12 @@ This tile is meant to be used in conjunction with the `beedk-acs-platform-it-til 


In your Maven project, set the following properties to define the behavior of this Maven Tile.  Unless otherwise stated, they can only be overridden in the project POM or other Maven Tiles loaded earlier than this Maven Tile.



### Public API



The following properties are intended to be exposed by inheriting Public API Maven Tiles.



| Maven Property                   | Required | Default         | Description |

| -------------------------------- |:--------:| --------------- | ----------- |

| `alfresco.transform-aio.version` |          | *not important* | The version of the [Alfresco Transform Core Engine Docker Image](https://hub.docker.com/r/alfresco/alfresco-transform-core-aio/tags). |



### Other APIs



Additional less important configurations are inherited from the following Maven Tiles.



*   [`beedk-run-tile`](/inteligr8/ootbee-beedk/src/stable/beedk-run-tile)

*   [`beedk-run-tile`](/inteligr8/ootbee-beedk/src/stable/beedk-ate-test-tile)



## Results

beedk-acs-lts-it-tile/pom.xml

+1 −1
Original line number Diff line number Diff line
@@ -10,7 +10,7 @@ 
	<parent>

		<groupId>com.inteligr8.ootbee</groupId>

		<artifactId>beedk-parent</artifactId>

		<version>1.0-SNAPSHOT</version>

		<version>1.1-SNAPSHOT</version>

		<relativePath>..</relativePath>

	</parent>

beedk-acs-lts-it-tile/tile.xml

+4 −6
Original line number Diff line number Diff line
@@ -24,7 +24,6 @@ 
			<plugin>

				<groupId>io.fabric8</groupId>

				<artifactId>docker-maven-plugin</artifactId>

				<version>${beedk.plugins.fabric8.docker.version}</version>

				<executions>

					<execution>

						<id>start-alts</id>
@@ -33,7 +32,7 @@ 
						<configuration>

							<images>

								<image>

									<name>alfresco/alfresco-transform-core-aio:${alfresco.transform-aio.version}</name>

									<name>alfresco/alfresco-transform-core-aio:${ate-aio.version}</name>

									<alias>ate-aio</alias>

									<run>

										<skip>${skipTests}</skip>
@@ -53,7 +52,7 @@ 
						<configuration>

							<images>

								<image>

									<name>alfresco/alfresco-transform-core-aio:${alfresco.transform-aio.version}</name>

									<name>alfresco/alfresco-transform-core-aio:${ate-aio.version}</name>

									<alias>ate-aio</alias>

								</image>

							</images>
@@ -73,9 +72,6 @@ 
				</property>

			</activation>

			<properties>

				<!-- versions -->

				<alfresco.transform-aio.version>2.3.6</alfresco.transform-aio.version>



				<!-- configuring beedk-acs-platform-it-tile -->

				<beedk.deploy.alts.enabled>true</beedk.deploy.alts.enabled>

			</properties>
@@ -85,6 +81,8 @@ 
	<tiles>

		<!-- Documentation: https://bitbucket.org/inteligr8/ootbee-beedk/src/stable/beedk-run-tile -->

		<tile>@project.groupId@:beedk-run-tile:@project.version@</tile>

		<!-- Documentation: https://bitbucket.org/inteligr8/ootbee-beedk/src/stable/beedk-ate-test-tile -->

		<tile>@project.groupId@:beedk-ate-test-tile:@project.version@</tile>

	</tiles>



</project>