Explicación del entorno de compilación

Generar detalles del entorno

Cloud Manager crea y prueba su código mediante un entorno de compilación especializado. Este entorno tiene los siguientes atributos:

  • El entorno de compilación está basado en Linux, derivado de Ubuntu 18.04.

  • Apache Maven 3.6.0 está instalado.

  • Las versiones de Java instaladas son Oracle JDK 8u202, Azul Zulu 8u292, Oracle JDK 11.0.2 y Azul Zulu 11.0.11.

  • Hay algunos paquetes de sistema adicionales instalados que son necesarios:

    • bzip2
    • descomprimir
    • libpng
    • imagemagick
    • graphicsmagick
  • Se pueden instalar otros paquetes en el momento de la compilación como se describe debajo.

  • Cada construcción se realiza en un entorno prístino; el contenedor de compilación no mantiene ningún estado entre ejecuciones.

  • Maven siempre se ejecuta con los tres comandos siguientes:

    • mvn --batch-mode org.apache.maven.plugins:maven-dependency-plugin:3.1.2:resolve-plugins
    • mvn --batch-mode org.apache.maven.plugins:maven-clean-plugin:3.1.0:clean -Dmaven.clean.failOnError=false
    • mvn --batch-mode org.jacoco:jacoco-maven-plugin:prepare-agent packageco-maven-plugin:prepare-agent package
  • Maven se configura a nivel de sistema con un archivo settings.xml que incluye automáticamente el repositorio de Adobe público Artifact mediante un perfil denominado adobe-public. (Consulte Repositorio de Maven Público de Adobe para obtener más información).

NOTA

Aunque Cloud Manager no define una versión específica del jacoco-maven-plugin, la versión utilizada debe ser al menos 0.7.5.201505241946.

Uso de una versión de Java específica

De forma predeterminada, los proyectos se crean mediante el proceso de compilación de Cloud Manager con el JDK de Oracle 8. Los clientes que deseen utilizar un JDK alternativo tienen dos opciones: Maven Toolchain y seleccionar una versión JDK alternativa para todo el proceso de ejecución de Maven.

Cadenas de herramientas de Maven

El Complemento Maven Toolchain permite que los proyectos seleccionen un JDK específico (o toolchain) para utilizarlo en el contexto de los complementos Maven que tengan en cuenta las cadenas de herramientas. Esto se realiza en el archivo pom.xml del proyecto especificando un proveedor y un valor de versión. Una sección de ejemplo en el archivo pom.xml es:

<plugin>
    <groupId>org.apache.maven.plugins</groupId>
    <artifactId>maven-toolchains-plugin</artifactId>
    <version>1.1</version>
    <executions>
        <execution>
            <goals>
                <goal>toolchain</goal>
            </goals>
        </execution>
    </executions>
    <configuration>
        <toolchains>
            <jdk>
                <version>11</version>
                <vendor>oracle</vendor>
            </jdk>
        </toolchains>
    </configuration>
</plugin>

Esto hará que todos los plugins Maven con conocimiento de herramientas utilicen el Oracle JDK, versión 11.

Al utilizar este método, el propio Maven sigue ejecutándose utilizando el JDK predeterminado (Oracle 8). Por lo tanto, la comprobación o aplicación de la versión de Java a través de complementos como el plugin Apache Maven Enforcer no funciona y estos plugins no deben usarse.

Las combinaciones de proveedor/versión disponibles actualmente son:

  • oracle 1.8
  • oracle 1.11
  • oracle 11
  • sun 1.8
  • sun 1.11
  • sol 11
  • azul 1.8
  • azul 1.11
  • azul 8

Versión JDK de ejecución de Maven alternativa

También es posible seleccionar Azul 8 o Azul 11 como JDK para toda la ejecución de Maven. A diferencia de las opciones de toolchain, esto cambia el JDK utilizado para todos los plugins a menos que también se establezca la configuración de toolchain en cuyo caso la configuración de toolchain se sigue aplicando a los plugins Maven según las cadenas de herramientas. Como resultado, la comprobación y aplicación de la versión de Java mediante el plugin Apache Maven Enforcer funcionará.

Para ello, cree un archivo denominado .cloudmanager/java-version en la rama del repositorio de Git utilizada por la canalización. Este archivo puede tener el contenido 11 u 8. Se ignora cualquier otro valor. Si se especifica 11, se usa Azul 11. Si se especifica 8, se usa Azul 8.

NOTA

En una futura versión de Cloud Manager, que actualmente se estima estará en octubre de 2021, el JDK predeterminado cambiará y el predeterminado será Azul 11. Los proyectos que no sean compatibles con Java 11 deben crear este archivo con el contenido 8 lo antes posible para garantizar que no se vean afectados por este conmutador.

Variables de entorno

Variables de entorno estándar

En algunos casos, los clientes consideran necesario variar el proceso de compilación en función de la información sobre el programa o la canalización.

Por ejemplo, si se está minificando JavaScript en tiempo de compilación, a través de una herramienta como gulp, puede haber un deseo de usar un nivel de minificación diferente al crear para un entorno de desarrollo, en lugar de construir para fase y producción.

Para admitir esto, Cloud Manager agrega estas variables de entorno estándar al contenedor de compilación para cada ejecución.

Nombre de variable Definición
CM_BUILD Siempre se configura como "true"
RAMA La rama configurada para la ejecución
CM_PIPELINE_ID El identificador numérico de la canalización
CM_PIPELINE_NAME El nombre de la canalización
CM_PROGRAM_ID Identificador numérico del programa
CM_PROGRAM_NAME El nombre del programa
ARTIFACTS_VERSION Para una fase o canalización de producción, la versión sintética generada por Cloud Manager
CM_AEM_PRODUCT_VERSION El nombre de la versión

Variables de canalización

En algunos casos, el proceso de compilación de un cliente puede depender de variables de configuración específicas que no deberían colocarse en el repositorio de Git o deberían variar entre las ejecuciones de canalización que utilizan la misma rama.

Cloud Manager permite que estas variables se configuren mediante la API de Cloud Manager o la CLI de Cloud Manager por canalización. Las variables pueden almacenarse como texto sin formato o cifrarse en reposo. En cualquier caso, las variables están disponibles dentro del entorno de compilación como una variable de entorno a la que se puede hacer referencia desde el archivo pom.xml u otras secuencias de comandos de compilación.

Para configurar una variable usando la CLI, ejecute un comando como:

$ aio cloudmanager:set-pipeline-variables PIPELINEID --variable MY_CUSTOM_VARIABLE test

Las variables actuales pueden enumerarse:

$ aio cloudmanager:list-pipeline-variables PIPELINEID

Los nombres de las variables solo pueden contener caracteres alfanuméricos y subrayados (_). Por convención, los nombres deben estar en mayúsculas. Hay un límite de 200 variables por canalización, cada nombre debe tener menos de 100 caracteres y cada valor debe tener menos de 2048 caracteres en el caso de variables de tipo cadena y 500 caracteres en el caso de variables de tipo secretString.

Cuando se utiliza dentro de un archivo Maven pom.xml, normalmente resulta útil asignar estas variables a las propiedades de Maven mediante una sintaxis similar a esta:

        <profile>
            <id>cmBuild</id>
            <activation>
                <property>
                    <name>env.CM_BUILD</name>
                </property>
            </activation>
            <properties>
                <my.custom.property>${env.MY_CUSTOM_VARIABLE}</my.custom.property> 
            </properties>
        </profile>

Instalación de paquetes de sistema adicionales

Algunas compilaciones requieren que se instalen paquetes de sistema adicionales para funcionar completamente. Por ejemplo, una compilación puede invocar un script Python o ruby y, como resultado, necesita tener instalado un intérprete de idioma adecuado. Esto se puede hacer llamando al exec-maven-plugin para invocar APT. Esta ejecución debe envolverse generalmente en un perfil Maven específico de Cloud Manager. Por ejemplo, para instalar python:

        <profile>
            <id>install-python</id>
            <activation>
                <property>
                        <name>env.CM_BUILD</name>
                </property>
            </activation>
            <build>
                <plugins>
                    <plugin>
                        <groupId>org.codehaus.mojo</groupId>
                        <artifactId>exec-maven-plugin</artifactId>
                        <version>1.6.0</version>
                        <executions>
                            <execution>
                                <id>apt-get-update</id>
                                <phase>validate</phase>
                                <goals>
                                    <goal>exec</goal>
                                </goals>
                                <configuration>
                                    <executable>apt-get</executable>
                                    <arguments>
                                        <argument>update</argument>
                                    </arguments>
                                </configuration>
                            </execution>
                            <execution>
                                <id>install-python</id>
                                <phase>validate</phase>
                                <goals>
                                    <goal>exec</goal>
                                </goals>
                                <configuration>
                                    <executable>apt-get</executable>
                                    <arguments>
                                        <argument>install</argument>
                                        <argument>-y</argument>
                                        <argument>--no-install-recommends</argument>
                                        <argument>python</argument>
                                    </arguments>
                                </configuration>
                            </execution>
                        </executions>
                    </plugin>
                </plugins>
            </build>
        </profile>

Esta misma técnica se puede utilizar para instalar paquetes específicos del idioma, es decir, utilizar gem para RubyGems o pip para paquetes Python.

NOTA

La instalación de un paquete del sistema de esta manera not lo instala en el entorno de tiempo de ejecución utilizado para ejecutar Adobe Experience Manager. Si necesita instalar un paquete del sistema en el entorno de AEM, póngase en contacto con su representante de Adobe.

En esta página