Repository files navigation

This project could be used to start developingapplication/library based on AEM.

To start developinglong-term project based on AEM it is recommended to useGradle AEM Multi instead.

Documentation for AEM plugin is available in projectGradle AEM Plugin.

• Quickstart
• Environment
• Building
• Tips & tricks
• Running tests
• Attaching debugger
• Extending build

1. Fork project using command:

   git clone https://github.com/wttech/gradle-aem-single.git&&cd gradle-aem-single&& sh gradlew fork

   and specify properties:

   

   and wait until project is forked then enter configured target directory.

2. Setup user specific project configuration using command:

   sh gradlew props

   and specify properties:

   

3. Setup local AEM instances and dependencies then build application using command:

   sh gradlew setup

   and wait till complete AEM environment will be ready to use.

4. Develop continuously application using command:

   sh gradlew

Tested on:

• Java 1.8
• Gradle 6.3
• Adobe AEM 6.5

1. Use commandgradlew so that Gradle in version according to project will be downloaded automatically.
2. Deploy application:sh gradlew <=>sh gradlew :packageDeploy

1. Monitoring errors in logs:sh gradlew :instanceTail,
2. Synchronizing JCR content from AEM to local file system:sh gradlew :sync,
3. Copying JCR content between AEM instances:sh gradlew :rcp -Prcp.source=http://user:pass@x.x.x.x:4502 -Prcp.target=local-author -Prcp.paths=[/content/example,/content/dam/example]

• According torecommendations, Gradle daemon should be:
  • enabled on development environments,
  • disabled on continuous integration environments.
• To see more descriptive errors or want to skip some tasks, see command linedocumentation.

Certain unit tests may depend on the results of running gradle tasks. One such example is the testing of OSGi Services usingOSGi Mocks where in order to run a test, the SCR metadata must be available for a class. Running a test like this in IntelliJ results in errors because the IDE is not aware of the Bundle plugin.

This can be worked around by configuring IntelliJ to delegate test execution to Gradle. In order to set this up, go toSettings > Build, Execution, Deployment > Gradle > Runner and set your IDE to delegate IDE build/run actions to Gradle. Alternatively, you can use a dropdown menu to use a specific runner or to decide on a test-by-test basis.

1. Execute build with options-Dorg.gradle.debug=true --no-daemon, it will suspend,
2. Attach debugger on port 5005,
3. Suspension will be released and build should stop at breakpoint.

For defining new tasks directly in build see:

• Build Script Basics
• More about Tasks

The easiest way to implement custom plugins and use them in project is a technique related withbuildSrc/ directory.For more details please readdocumentation.