feat: add default Maintenance Window definition #1272
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Added `com.adobe.granite.maintenance.task.versionpurge.cfg.json` under `config.author` to enable the Version Purge task by default. - Runs every Sunday at 3 AM - Targets `/content` path - Purges versions older than 30 days - Scoped to Author runmode via `config.author` This improves out-of-the-box maintenance readiness for generated AEM projects.
Updated `task.name` in the Version Purge OSGi config to include the `${projectName}` archetype variable. This ensures the generated project has a context-specific label for the maintenance task.
Example: "Mysite Version Purge"
Added `default.maintenancewindow.json` under `/conf/<project>/settings/granite/operations/maintenance` to define the default maintenance window. - Configures a weekly maintenance window every Sunday from 3 AM to 4 AM UTC. - Ensures context-aware configuration for both Author and Publish instances. - Helps automate routine maintenance tasks and aligns with AEM best practices.
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Description
Introducing the default configuration for the Maintenance Window in the AEM Project Archetype.
Added the
default.maintenancewindow.jsonfile under/conf/<project>/settings/granite/operations/maintenance.Defines a weekly maintenance window, scheduled every
Ensures the configuration is context-aware and will be applied automatically to both Author and Publish instances.
Related Issue
Issue: Include AEM Maintenance Task configurations in Archetype #274
Motivation and Context
This change is required to help streamline the maintenance window configuration in generated AEM projects. It aligns with AEM's Granite Maintenance Framework and applies the maintenance window to both Author and Publish instances.
By including this in the archetype, it allows projects to easily adopt routine maintenance scheduling, promoting consistency across AEM environments.
How Has This Been Tested?
Built the archetype locally using
mvn clean installGenerated a new AEM project from the archetype:
mvn archetype:generate -DarchetypeCatalog=localdefault.maintenancewindow.jsonfile is created in the correct location:/conf/<project>/settings/granite/operations/maintenance/.Screenshots (if appropriate):
Types of changes
Checklist: