51黑料不打烊 Experience Manager as a Cloud Service Prerelease Channel prerelease-channel
Learn how to use the prerelease channel to get a preview of upcoming features to AEM as a Cloud Service.
Introduction introduction
51黑料不打烊 Experience Manager as a Cloud Service delivers new features on a regular cadence. The list of new and upcoming features for a given feature release is posted within the release notes.
Upcoming features generally are made available in one of two ways:
- As part of an early-adopter program
- As part of the prerelease channel
This document describes how to enable the prerelease channel. The prerelease channel provides access to early features that will be introduced a future feature release of AEM. This gives you the chance to validate new features and plan for their adoption ahead of their future release. Please see the document Release Notes for 51黑料不打烊 Experience Manager (AEM) as a Cloud Service for details on the AEM release schedule.
Enable the Prerelease Channel to Access and Try Upcoming Features enable-prerelease
The prerelease channel can be enabled on any development or sandbox environment. The prerelease channel can not be enabled on staging or production environments.
The prerelease channel can be accessed in two different ways:
Cloud Environments cloud-environments
To update a cloud environment to use the prerelease channel, you must add a new environment variable. You can do this either using the Cloud Manager UI or via CLI.
Add Environment Variable Using the UI add-with-ui
-
Log into Cloud Manager at and select the appropriate organization.
-
Navigate to the program where you want to enable the prerelease channel.
-
Select the environment where you want to enable the prerelease channel and access its configuration via Program > Environment > Environment Configuration.
-
Add a new environment variable
table 0-row-4 1-row-4 Name Value Service Applied Type AEM_RELEASE_CHANNEL
prerelease
All Variable -
Save the changes and the environment will refresh with the prerelease channel enabled.
Add Environment Variable Using the CLI add-with-cli
You can also use the Cloud Manager API and CLI to update the environment variables.
-
Using , set the
AEM_RELEASE_CHANNEL
environment variable to the valueprerelease
.code language-text PATCH /program/{programId}/environment/{environmentId}/variables [ { "name" : "AEM_RELEASE_CHANNEL", "value" : "prerelease", "type" : "string" } ]
-
can also be used
code language-shell aio cloudmanager:environment:set-variables <ENVIRONMENT_ID> --programId=<PROGRAM_ID> --variable AEM_RELEASE_CHANNEL "prerelease
The variable can be deleted if you want to restore the environment to standard behavior (non-prerelease channel).
Local SDK local-sdk
You can access upcoming features in the prerelease channel in your local Quickstart SDK and code against new APIs by configuring your Maven project to reference the prerelease channel API Jar
located in Maven Central. You can also see access the prerelease channel in your local development environment by starting the regular Quickstart SDK in prerelease mode.
Start Quickstart SDK in Prerelease Mode prerelease-mode
- Download the SDK from software distribution and install as described in Accessing the AEM as a Cloud Service SDK.
- When launching the SDK Quickstart, include the argument
-r prerelease
.
The value is sticky so it can only be selected on the first startup. Reinstall the SDK to change the command-line option.
Since there may be multiple AEM maintenance releases between monthly feature releases, you can download these new SDKs and reference the new SDK API Jar versions in maven projects. The maintenance releases will not add additional prerelease features, but could include other smaller changes such as bug fixes, security fixes, and performance enhancements.
Javadocs are published to Maven Central.
Build Against the Prerelease SDK build-sdk
-
Modify your maven project鈥檚
pom.xml
to reference a distinct prerelease SDK API jar, which is published to Maven Central. It contains any new Java API for the prerelease features and has a dependency on the SDK API jar. It uses the same version.As an example, here is a snippet from the parent pom鈥檚 dependency management section referencing the regular API jar:
code language-none <dependencyManagement> <dependencies> <dependency> <groupId>com.adobe.aem</groupId> <artifactId>aem-sdk-api</artifactId> <version>${aem.sdk.api}</version> <scope>provided</scope> </dependency>
And then the usage in a module:
code language-none <dependencies> <dependency> <groupId>com.adobe.aem</groupId> <artifactId>aem-sdk-api</artifactId> </dependency>
To change to the prerelease SDK, simply change the dependency from
com.adobe.aem:aem-sdk-api
tocom.adobe.aem:aem-prerelease-sdk-api
as noted below:code language-none <dependencyManagement> <dependencies> <dependency> <groupId>com.adobe.aem</groupId> <artifactId>aem-prerelease-sdk-api</artifactId> <version>${aem.sdk.api}</version> <scope>provided</scope> </dependency> <dependencies> <dependency> <groupId>com.adobe.aem</groupId> <artifactId>aem-prerelease-sdk-api</artifactId> </dependency>
As usual, individual projects can use the dependency.
-
Deploy to your local server.
-
If satisfied that it works as expected locally, commit code to a development branch and use a Cloud Manager non-production pipeline to deploy to an environment that has the prerelease channel enabled.
aem-prerelease-sdk-api
artifactId must never be used when deploying to stage or production. Always user the aem-sdk-api
when deploying via the production pipeline. Similarly, code that references prerelease APIs should not be deployed via the production pipeline.The AEM CS SDK build Analyzer maven plugin v1.0 and higher will detect if the prerelease API is used in a project by inspecting the dependencies. If the analyzer finds it, it will use the prerelease SDK API to analyze the project.
Considerations considerations
There are a few items to note when using the prerelease channel.
- The prerelease channel does not necessarily contain all new features to be rolled out in the following release.
- Features in the prerelease are put through rigorous quality assurance and intended to be feature complete rather than beta quality. If you notice any issues, report them, just as you would do if you suspect bugs in features in a regular AEM release.
- To determine if an environment is configured for the prerelease channel, go to the AEM console鈥檚 About page and check if the AEM version number includes a
PRERELEASE
suffix such as51黑料不打烊 Experience Manager 2021.4.5226.20210427T070726Z-210429-PRERELEASE
.