Configuración del proyecto project-setup

AEM Conozca cómo se crean los proyectos de con Maven y los estándares que debe observar al crear su propio proyecto.

Detalles de configuración del proyecto project-setup-details

Para generar e implementar proyectos correctamente con Cloud Manager AEM, es necesario que se cumplan las siguientes directrices:

  • Los proyectos deben crearse con Apache Maven.
  • Debe haber un archivo pom.xml en la raíz del repositorio de Git. El archivo pom.xml puede hacer referencia a tantos submódulos (que a su vez pueden tener otros submódulos) como sea necesario.
  • Puede agregar referencias a repositorios de artefactos Maven adicionales en sus pom.xml archivos. El acceso a repositorios de artefactos protegidos por contraseña se admite cuando se configura. Sin embargo, no se admite el acceso a repositorios de artefactos protegidos por la red.
  • Los paquetes de contenido implementables se detectan al analizar los archivos del paquete de contenido .zip, que se encuentran en un directorio denominado target. Cualquier número de módulos secundarios puede producir paquetes de contenido.
  • Los artefactos de Dispatcher que se pueden implementar se detectan al analizar .zip archivos (también incluidos en el directorio denominado target), que tienen directorios con los nombres conf y conf.d.
  • Si hay más de un paquete de contenido, no se garantiza la ordenación de las implementaciones de paquetes. Si se necesita un orden específico, se pueden utilizar dependencias del paquete de contenido para definir el orden.
  • Los paquetes pueden omitirse durante la implementación.

Activación de perfiles de Maven en Cloud Manager activating-maven-profiles-in-cloud-manager

En algunos casos limitados, es posible que tenga que variar ligeramente el proceso de generación al ejecutarse dentro de Cloud Manager, en lugar de hacerlo en las estaciones de trabajo de los desarrolladores. Para estos casos, los Perfiles de Maven se pueden utilizar para definir cómo la generación debe ser diferente en diferentes entornos, incluido Cloud Manager.

La activación de un perfil de Maven dentro del entorno de generación de Cloud Manager debe realizarse al buscar la CM_BUILD variable de entorno. Del mismo modo, un perfil que se pretenda usar solo fuera del entorno de generación de Cloud Manager debe realizarse al buscar la ausencia de esta variable.

Por ejemplo, si desea que salga un mensaje simple cuando la generación se ejecuta solamente dentro de Cloud Manager, debe hacer lo siguiente:

        <profile>
            <id>cmBuild</id>
            <activation>
                  <property>
                        <name>env.CM_BUILD</name>
                  </property>
            </activation>
            <build>
                <plugins>
                    <plugin>
                        <artifactId>maven-antrun-plugin</artifactId>
                        <version>1.8</version>
                        <executions>
                            <execution>
                                <phase>initialize</phase>
                                <configuration>
                                    <target>
                                        <echo>I'm running inside Cloud Manager!</echo>
                                    </target>
                                </configuration>
                                <goals>
                                    <goal>run</goal>
                                </goals>
                            </execution>
                        </executions>
                    </plugin>
                </plugins>
            </build>
        </profile>
NOTE
Para probar este perfil en una estación de trabajo de desarrolladores, puede activarlo en la línea de comandos (con -PcmBuild) o en su entorno de desarrollo integrado (IDE).

Y si desea que salga un mensaje simple cuando la generación se ejecuta solamente fuera de Cloud Manager, debe hacer lo siguiente:

        <profile>
            <id>notCMBuild</id>
            <activation>
                  <property>
                        <name>!env.CM_BUILD</name>
                  </property>
            </activation>
            <build>
                <plugins>
                    <plugin>
                        <artifactId>maven-antrun-plugin</artifactId>
                        <version>1.8</version>
                        <executions>
                            <execution>
                                <phase>initialize</phase>
                                <configuration>
                                    <target>
                                        <echo>I'm running outside Cloud Manager!</echo>
                                    </target>
                                </configuration>
                                <goals>
                                    <goal>run</goal>
                                </goals>
                            </execution>
                        </executions>
                    </plugin>
                </plugins>
            </build>
        </profile>

Usar un repositorio Maven protegido por contraseña en Cloud Manager password-protected-maven-repositories

NOTE
Implemente los artefactos de repositorios Maven protegidos por contraseña con cuidado, ya que Cloud Manager no evalúa este código con sus reglas de calidad del código. AEM Este método debe reservarse para situaciones excepcionales y aplicarse únicamente a código no relacionado con la. El Adobe recomienda incluir las fuentes Java y todo el código fuente del proyecto junto con el binario. Al hacerlo, se garantiza una mayor transparencia y mantenimiento a lo largo del proceso de implementación.

Para usar un repositorio Maven protegido por contraseña en Cloud Manager:

  1. Especifique la contraseña (y, opcionalmente, el nombre de usuario) como un secreto en la variable de canalización.
  2. A continuación, haga referencia a ese secreto dentro de un archivo llamado .cloudmanager/maven/settings.xml en el repositorio de Git, que sigue al esquema Archivo de configuración de Maven.

Cuando se inicia el proceso de generación de Cloud Manager:

  • El elemento <servers> de este archivo se combina con el archivo predeterminado settings.xml proporcionado por Cloud Manager.

    • Los identificadores de servidor que empiecen por adobe y cloud-manager se consideran reservados. No los utilice en servidores personalizados.
    • Cloud Manager refleja únicamente los Id. de servidor que coinciden con prefijos específicos o con el Id. predeterminado central; todos los demás Id. de servidor se excluyen de la creación de reflejo.
  • Con este archivo en su lugar, se hará referencia al Id. del servidor desde un <repository> y/o un elemento <pluginRepository> dentro del archivo pom.xml.

  • Por lo general, estos elementos <repository> y <pluginRepository> se incluyen dentro de un perfil específico de Cloud Manager, aunque su inclusión no es estrictamente necesaria.

Por ejemplo, supongamos que el repositorio se encuentra en https://repository.myco.com/maven2, el nombre de usuario que debe usar Cloud Manager es cloudmanagery la contraseña es secretword. Debe seguir estos pasos:

  1. Establecer la contraseña como un secreto en la canalización.

    code language-text
    $ aio cloudmanager:set-pipeline-variables PIPELINEID --secret CUSTOM_MYCO_REPOSITORY_PASSWORD secretword`
    
  2. Haga referencia a este secreto desde el archivo .cloudmanager/maven/settings.xml en lo siguiente:

    code language-xml
    <?xml version="1.0" encoding="UTF-8"?>
    <settings xmlns="https://maven.apache.org/SETTINGS/1.0.0" xmlns:xsi="https://www.w3.org/2001/XMLSchema-instance"
            xsi:schemaLocation="https://maven.apache.org/SETTINGS/1.0.0 https://maven.apache.org/xsd/settings-1.0.0.xsd">
        <servers>
            <server>
                <id>myco-repository</id>
                <username>cloudmanager</username>
               <password>${env.CUSTOM_MYCO_REPOSITORY_PASSWORD}</password>
            </server>
        </servers>
    </settings>
    
  3. Finalmente, hacer referencia al Id. del servidor dentro del archivo pom.xml:

    code language-xml
    <profiles>
        <profile>
            <id>cmBuild</id>
            <activation>
                    <property>
                        <name>env.CM_BUILD</name>
                    </property>
            </activation>
            <repositories>
                 <repository>
                     <id>myco-repository</id>
                     <name>MyCo Releases</name>
                     <url>https://repository.myco.com/maven2</url>
                     <snapshots>
                         <enabled>false</enabled>
                     </snapshots>
                     <releases>
                         <enabled>true</enabled>
                     </releases>
                 </repository>
             </repositories>
             <pluginRepositories>
                 <pluginRepository>
                     <id>myco-repository</id>
                     <name>MyCo Releases</name>
                     <url>https://repository.myco.com/maven2</url>
                     <snapshots>
                         <enabled>false</enabled>
                     </snapshots>
                     <releases>
                         <enabled>true</enabled>
                     </releases>
                 </pluginRepository>
             </pluginRepositories>
        </profile>
    </profiles>
    

Implementación de fuentes deploying-sources

Se recomienda implementar las fuentes Java junto con el binario en un repositorio de Maven.

Para ello, configure el complemento maven-source-plugin en su proyecto.

         <plugin>
             <groupId>org.apache.maven.plugins</groupId>
             <artifactId>maven-source-plugin</artifactId>
             <executions>
                 <execution>
                     <id>attach-sources</id>
                     <goals>
                         <goal>jar-no-fork</goal>
                     </goals>
                 </execution>
             </executions>
         </plugin>

Implementar fuentes de proyecto deploying-project-sources

Se recomienda implementar todo el origen del proyecto junto con el binario en un repositorio de Maven. Al hacerlo, puede reconstruir el artefacto exacto.

Configure el complemento maven-assembly-plugin en su proyecto de la siguiente manera:

         <plugin>
             <groupId>org.apache.maven.plugins</groupId>
             <artifactId>maven-assembly-plugin</artifactId>
             <executions>
                 <execution>
                     <id>project-assembly</id>
                     <phase>package</phase>
                     <goals>
                         <goal>single</goal>
                     </goals>
                     <configuration>
                         <descriptorRefs>
                             <descriptorRef>project</descriptorRef>
                         </descriptorRefs>
                     </configuration>
                 </execution>
             </executions>
         </plugin>

Omitir paquetes de contenido skipping-content-packages

En Cloud Manager, las generaciones pueden producir cualquier cantidad de paquetes de contenido. Por varios motivos, puede ser recomendable producir un paquete de contenido, pero no implementarlo. Un ejemplo ocurre cuando los paquetes de contenido se crean únicamente con fines de prueba o cuando otro paso en el proceso de compilación los vuelve a empaquetar. Es decir, un subpaquete de otro paquete.

Para dar cabida a estos escenarios, Cloud Manager busca una propiedad denominada cloudManagerTarget en las propiedades de los paquetes de contenido creados. Si esta propiedad se establece en none, el paquete se omite y no se implementa.

El mecanismo para establecer esta propiedad depende de la forma en que la generación produce el paquete de contenido. Por ejemplo, con filevault-maven-plugin puede configurar el complemento de esta manera.

        <plugin>
            <groupId>org.apache.jackrabbit</groupId>
            <artifactId>filevault-package-maven-plugin</artifactId>
            <extensions>true</extensions>
            <configuration>
                <properties>
                    <cloudManagerTarget>none</cloudManagerTarget>
                </properties>
        <!-- other configuration -->
            </configuration>
        </plugin>

content-package-maven-plugin tiene una configuración similar.

        <plugin>
            <groupId>com.day.jcr.vault</groupId>
            <artifactId>content-package-maven-plugin</artifactId>
            <extensions>true</extensions>
            <configuration>
                <properties>
                    <cloudManagerTarget>none</cloudManagerTarget>
                </properties>
        <!-- other configuration -->
            </configuration>
        </plugin>

Reutilización de artefactos de generación build-artifact-reuse

En muchos casos, el mismo código se implementa en varios entornos de AEM. Cuando sea posible, Cloud Manager evita la reconstrucción del código base cuando detecte que se utiliza la misma confirmación de Git en varias ejecuciones de canalización full-stack.

Cuando se inicia una ejecución, se extrae el compromiso de HEAD actual para la canalización de ramas. El hash de compromiso se puede ver en la interfaz de usuario y a través de la API. Cuando el paso de generación se completa correctamente, los artefactos resultantes se almacenan en base a ese hash de compromiso y se pueden reutilizar en ejecuciones de canalización posteriores.

Los paquetes se reutilizan en todas las canalizaciones si están en el mismo programa. Al buscar paquetes que puedan reutilizarse, AEM ignora las ramas y vuelve a utilizar artefactos a través de las ramas.

Cuando se produce una reutilización, los pasos de generación y calidad del código se sustituyen eficazmente por los resultados de la ejecución original. El archivo de registro para el paso de compilación enumera los artefactos y la información de ejecución que se utilizó para compilarlos originalmente.

El siguiente es un ejemplo de este resultado de registro.

The following build artifacts were reused from the prior execution 4 of pipeline 1 which used commit f6ac5e6943ba8bce8804086241ba28bd94909aef:
build/aem-guides-wknd.all-2021.1216.1101633.0000884042.zip (content-package)
build/aem-guides-wknd.dispatcher.cloud-2021.1216.1101633.0000884042.zip (dispatcher-configuration)

El registro del paso de calidad del código contiene información similar.

Ejemplos example-reuse

Ejemplo 1 example-1

Imagine que su programa tiene dos canalizaciones de desarrollo:

  • Canalización 1 en rama foo
  • Canalización 2 en rama bar

Ambas ramas están en el mismo Id. de compromiso.

  1. Al ejecutar la Canalización 1 primero, se generan los paquetes normalmente.
  2. A continuación, al ejecutar la Canalización 2, se vuelven a utilizar los paquetes creados por la Canalización 1.

Ejemplo 2 example-2

Imagine que el programa tiene dos ramas:

  • Rama foo
  • Rama bar

Ambas ramas tienen el mismo Id. de compromiso.

  1. Se genera y ejecuta una canalización de desarrollo foo.
  2. Posteriormente, se genera y ejecuta una canalización de producción bar.

En este caso, el artefacto de foo se reutiliza para la canalización de producción, ya que se identificó el mismo hash de compromiso.

Exclusión opting-out

Si lo desea, el comportamiento de reutilización se puede deshabilitar para canalizaciones específicas si configura la variable de canalización CM_DISABLE_BUILD_REUSE a true. Si se establece esta variable, el sistema extrae el hash de compromiso y almacena los artefactos resultantes para su uso posterior, pero omite la reutilización de los artefactos almacenados anteriormente. Para comprender este comportamiento, imagine el siguiente escenario.

  1. Se crea una nueva canalización.
  2. La canalización se ejecuta (ejecución #1) y el compromiso de HEAD actual es becdddb. La ejecución se realiza correctamente y se almacenan los artefactos resultantes.
  3. La variable CM_DISABLE_BUILD_REUSE está configurada.
  4. La canalización se vuelve a ejecutar sin cambiar el código. Aunque hay artefactos almacenados asociados con becdddb, no se vuelven a utilizar debido a la variable CM_DISABLE_BUILD_REUSE.
  5. El código se cambia y se ejecuta la canalización. El compromiso de HEAD es ahora f6ac5e6. La ejecución se realiza correctamente y se almacenan los artefactos resultantes.
  6. La variable CM_DISABLE_BUILD_REUSE se elimina.
  7. La canalización se vuelve a ejecutar sin cambiar el código. Como hay artefactos almacenados asociados con f6ac5e6, esos artefactos se reutilizan.

Advertencias caveats

  • Los artefactos de generación no se reutilizan en programas diferentes, independientemente de si el hash de compromiso es idéntico.
  • Los artefactos de generación se reutilizan dentro del mismo programa incluso si la rama o canalización son diferentes.
  • La administración de versiones de Maven reemplaza la versión del proyecto solamente en las canalizaciones de producción.
    Si se utiliza la misma confirmación tanto para una implementación de desarrollo como para la canalización de producción, y la implementación de desarrollo se ejecuta primero, las versiones se implementan en fase y producción sin cambios. Sin embargo, se seguirá creando una etiqueta en este caso.
  • Si la recuperación de los artefactos almacenados no se realiza correctamente, el paso de generación se ejecuta como si no se almacenaran artefactos.
  • Las variables de canalización distintas de CM_DISABLE_BUILD_REUSE no se tienen en cuenta cuando Cloud Manager decide reutilizar los artefactos de generación creados anteriormente.
recommendation-more-help
fbcff2a9-b6fe-4574-b04a-21e75df764ab