Configuración y uso de Gradle Groovy - Amazon CodeCatalyst

Amazon CodeCatalyst ya no está disponible para nuevos clientes. Los clientes existentes pueden seguir utilizando el servicio con normalidad. Para obtener más información, consulte Cómo migrar de CodeCatalyst.

Configuración y uso de Gradle Groovy

Para usar Gradle Groovy con CodeCatalyst, debe conectar Gradle Groovy al repositorio de paquetes y proporcionar un token de acceso personal (PAT) para la autenticación. Puede consultar las instrucciones para conectar Gradle Groovy a un repositorio de paquetes en la consola de CodeCatalyst.

Obtención de dependencias de CodeCatalyst

Las siguientes instrucciones explican cómo configurar Gradle Groovy para obtener dependencias del repositorio de paquetes de CodeCatalyst.

Uso de Gradle Groovy para obtener dependencias del repositorio de paquetes de CodeCatalyst
  1. Abra la consola de CodeCatalyst en https://codecatalyst.aws/.

  2. Vaya a su proyecto.

  3. En el panel de navegación, elija Paquetes.

  4. Elija su repositorio de paquetes de la lista de repositorios de paquetes.

  5. Seleccione Establecer conexión con el repositorio.

  6. En el cuadro de diálogo Establecer conexión con el repositorio, seleccione Gradle Groovy en la lista de clientes de administrador de paquetes.

  7. Necesitará un token de acceso personal (PAT) para autenticar Gradle Groovy con CodeCatalyst. Si ya tiene uno, puede utilizarlo. De lo contrario, puede crear uno aquí.

    1. Seleccione Crear token.

    2. Seleccione Copiar para copiar el PAT.

      aviso

      Después de cerrar el cuadro de diálogo, no podrá volver a ver ni copiar el PAT.

  8. Actualice el archivo de propiedades de Gradle con sus credenciales de acceso. Sustituya username por su nombre de usuario de CodeCatalyst y sustituya PAT por su token de acceso personal de CodeCatalyst. Puede usar cualquier valor para spaceUsername y spacePassword, siempre que utilice los mismos valores en los siguientes pasos.

    spaceUsername=username spacePassword=PAT
  9. Para obtener las dependencias de CodeCatalyst en una compilación de Gradle, copie el fragmento de código de maven y añádalo a la sección repositories en el archivo build.gradle del proyecto. Reemplace los siguientes valores. Puede usar cualquier valor para spaceName, siempre que utilice los mismos valores en los siguientes pasos.

    nota

    Si va a copiar las instrucciones de la consola, los siguientes valores deben actualizarse automáticamente y no deben cambiarse.

    • Sustituya space_name por el nombre de su espacio de CodeCatalyst.

    • Sustituya proj_name por el nombre de su proyecto de CodeCatalyst.

    • Sustituya repo_name por el nombre de su repositorio de paquetes de CodeCatalyst.

    maven { name = 'spaceName' url = uri('https://packages.region.codecatalyst.aws/maven/space_name/proj_name/repo_name/') credentials(PasswordCredentials) }
  10. (Opcional) Para usar el repositorio de paquetes de CodeCatalyst como la única fuente de las dependencias del proyecto, elimine cualquier otra sección en los repositorios desde el archivo build.gradle. Si tiene más de un repositorio, Gradle busca las dependencias en cada repositorio en el orden en que aparecen en la lista.

Obtención de complementos desde CodeCatalyst

De forma predeterminada, Gradle resolverá los complementos desde el portal de complementos de Gradle público. En los siguientes pasos, configuraremos el proyecto de Gradle para resolver los complementos desde el repositorio de paquetes de CodeCatalyst.

Uso de Gradle para obtener complementos del repositorio de paquetes de CodeCatalyst
  1. Abra la consola de CodeCatalyst en https://codecatalyst.aws/.

  2. Vaya a su proyecto.

  3. En el panel de navegación, elija Paquetes.

  4. Elija su repositorio de paquetes de la lista de repositorios de paquetes.

  5. Seleccione Establecer conexión con el repositorio.

  6. En el cuadro de diálogo Establecer conexión con el repositorio, seleccione Gradle en la lista de clientes del administrador de paquetes.

  7. Necesitará un token de acceso personal (PAT) para autenticar Gradle con CodeCatalyst. Si ya tiene uno, puede utilizarlo. De lo contrario, puede crear uno aquí.

    1. Seleccione Crear token.

    2. Seleccione Copiar para copiar el PAT.

      aviso

      Después de cerrar el cuadro de diálogo, no podrá volver a ver ni copiar el PAT.

  8. Actualice el archivo de propiedades de Gradle con sus credenciales de acceso. Sustituya username por su nombre de usuario de CodeCatalyst y sustituya PAT por su token de acceso personal de CodeCatalyst. Puede usar cualquier valor para spaceUsername y spacePassword, siempre que utilice los mismos valores en los siguientes pasos.

    spaceUsername=username spacePassword=PAT
  9. Agregue un bloque pluginManagement a su archivo settings.gradle. El bloque pluginManagement debe aparecer antes de cualquier otra declaración en settings.gradle. Reemplace los siguientes valores.

    nota

    Si va a copiar las instrucciones de la consola, los siguientes valores deben actualizarse automáticamente y no deben cambiarse.

    • Sustituya spaceName por el valor de nombre utilizado en el paso anterior.

    • Sustituya space_name por el nombre de su espacio de CodeCatalyst.

    • Sustituya proj_name por el nombre de su proyecto de CodeCatalyst.

    • Sustituya repo_name por el nombre de su repositorio de paquetes de CodeCatalyst.

    pluginManagement { repositories { maven { name = 'spaceName' url = uri('https://packages.region.codecatalyst.aws/maven/space_name/proj_name/repo_name/') credentials(PasswordCredentials) } } }

    Esto garantizará que Gradle resuelva los complementos del repositorio especificado. El repositorio debe tener una conexión ascendente configurada con el portal de complementos de Gradle (gradle-plugins-store) para que los complementos de Gradle que se requieren con más frecuencia estén disponibles en la compilación. Para obtener más información, consulte la documentación de Gradle.

Obtención de paquetes desde repositorios de paquetes externos a través de CodeCatalyst

Puede instalar paquetes de Maven desde repositorios públicos a través de un repositorio de CodeCatalyst; para ello, configúrelo con una conexión ascendente a la puerta de enlace que representa el repositorio de puerta de enlace. Los paquetes instalados desde el repositorio de puerta de enlace se ingieren y almacenan en el repositorio de CodeCatalyst.

CodeCatalyst es compatible con los siguientes repositorios públicos de paquetes de Maven.

  • maven-central-gateway

  • google-android-gateway

  • gradle-plugins-gateway

  • commonsware-gateway

Instalación de paquetes desde repositorios públicos de paquetes de Maven
  1. Si aún no lo ha hecho, configure Gradle con el repositorio de paquetes de CodeCatalyst siguiendo los pasos indicados en Obtención de dependencias de CodeCatalyst o Obtención de complementos desde CodeCatalyst.

  2. Compruebe que su repositorio haya añadido el repositorio de puerta de enlace desde el que desea hacer la instalación como conexión ascendente. Para ello, siga las instrucciones en Adición de un repositorio ascendente y seleccione el repositorio de paquetes público que quiera añadir como ascendente.

Para obtener más información sobre cómo solicitar paquetes desde repositorios ascendentes, consulte Solicitar una versión de paquete con repositorios ascendentes.

Publicación de paquetes en CodeCatalyst

En esta sección, se describe cómo publicar una biblioteca de Java compilada con Gradle Groovy en un repositorio de CodeCatalyst.

Uso de Gradle Groovy para publicar paquetes en un repositorio de paquetes de CodeCatalyst
  1. Abra la consola de CodeCatalyst en https://codecatalyst.aws/.

  2. En la página de información general del proyecto, seleccione Paquetes.

  3. Elija su repositorio de paquetes de la lista de repositorios de paquetes.

  4. Seleccione Establecer conexión con el repositorio.

  5. En el cuadro de diálogo Establecer conexión con el repositorio, seleccione Gradle Groovy en la lista de clientes de administrador de paquetes.

  6. Necesitará un token de acceso personal (PAT) para autenticar Gradle con CodeCatalyst. Si ya tiene uno, puede utilizarlo. De lo contrario, puede crear uno aquí.

    1. Seleccione Crear token.

    2. Seleccione Copiar para copiar el PAT.

      aviso

      Después de cerrar el cuadro de diálogo, no podrá volver a ver ni copiar el PAT.

  7. Actualice el archivo de propiedades de Gradle con sus credenciales de acceso. Sustituya username por su nombre de usuario de CodeCatalyst y sustituya PAT por su token de acceso personal de CodeCatalyst. Puede usar cualquier valor para spaceUsername y spacePassword, siempre que utilice los mismos valores en los siguientes pasos.

    spaceUsername=username spacePassword=PAT
  8. Primero, añada el complemento maven-publish a la sección plugins del archivo build.gradle del proyecto.

    plugins { id 'java-library' id 'maven-publish' }
  9. A continuación, añada una sección publishing al archivo build.gradle del proyecto. Reemplace los siguientes valores.

    nota

    Si va a copiar las instrucciones de la consola, los siguientes valores deben actualizarse automáticamente y no deben cambiarse.

    • Sustituya space_name por el nombre de su espacio de CodeCatalyst.

    • Sustituya proj_name por el nombre de su proyecto de CodeCatalyst.

    • Sustituya repo_name por el nombre de su repositorio de paquetes de CodeCatalyst.

    publishing { publications { mavenJava(MavenPublication) { groupId = 'group-id' artifactId = 'artifact-id' version = 'version' from components.java } } repositories { maven { name = 'spaceName' url = uri('https://packages.region.codecatalyst.aws/maven/space_name/proj_name/repo_name/') credentials(PasswordCredentials) } } }

    El maven-publish genera un archivo POM basado en el groupId, artifactId y version especificado en la sección publishing.

  10. Una vez completados estos cambios en build.gradle, ejecute el siguiente comando para crear el proyecto y subirlo al repositorio.

    ./gradlew publish
  11. Vaya hasta el repositorio de paquetes en la consola de CodeCatalyst para comprobar que el paquete se haya publicado correctamente. Debería ver el paquete en la lista Paquetes del repositorio de paquetes.

Para obtener más información, consulte estos temas en el sitio web de Gradle:

Ejecución de una compilación de Gradle en IntelliJ IDEA

Puede ejecutar una compilación de Gradle en IntelliJ IDEA que extraiga dependencias de CodeCatalyst. Necesitará un token de acceso personal (PAT) para autenticar Gradle con CodeCatalyst. Puede almacenar el PAT de CodeCatalyst en gradle.properties o en un archivo independiente que usted elija.

Método 1: colocar el PAT en gradle.properties

Use este método si no está utilizando el archivo gradle.properties y puede sobrescribir el contenido con el PAT. Si está utilizando gradle.properties, puede modificar este método para añadir el PAT en lugar de sobrescribir el contenido del archivo.

nota

El ejemplo muestra el archivo gradle.properties ubicado en GRADLE_USER_HOME.

En primer lugar, cree un PAT si no tiene uno.

Creación de un token de acceso personal (PAT)
  1. En la barra de menú superior, elija su insignia de perfil y, a continuación, elija Mi configuración.

    sugerencia

    También puede encontrar su perfil de usuario en la página de miembros de un proyecto o espacio, seleccionando el nombre en la lista de miembros.

  2. En Nombre de PAT, introduzca un nombre descriptivo para el PAT.

  3. En Fecha de vencimiento, mantenga la fecha predeterminada o elija el icono del calendario para seleccionar una fecha personalizada. La fecha de vencimiento predeterminada es de 1 año a partir de la fecha actual.

  4. Seleccione Crear.

    También puede crear este token si elige Clonar repositorio para un repositorio de código fuente.

  5. Guarde el secreto del PAT en un lugar seguro.

    importante

    El secreto del PAT solo se muestra una vez. No podrá recuperarlo después de cerrar la ventana.

A continuación, actualice el archivo build.gradle con el siguiente fragmento:

repositories { maven { name = 'spaceName' url = uri('https://packages.region.codecatalyst.aws/maven/space_name/proj_name/repo_name/') credentials(PasswordCredentials) } }

Método 2: colocar el PAT en un archivo independiente

Utilice este método si no desea modificar el archivo gradle.properties.

En primer lugar, cree un PAT si no tiene uno.

Creación de un token de acceso personal (PAT)
  1. En la barra de menú superior, elija su insignia de perfil y, a continuación, elija Mi configuración.

    sugerencia

    También puede encontrar su perfil de usuario en la página de miembros de un proyecto o espacio, seleccionando el nombre en la lista de miembros.

  2. En Nombre de PAT, introduzca un nombre descriptivo para el PAT.

  3. En Fecha de vencimiento, mantenga la fecha predeterminada o elija el icono del calendario para seleccionar una fecha personalizada. La fecha de vencimiento predeterminada es de 1 año a partir de la fecha actual.

  4. Seleccione Crear.

    También puede crear este token si elige Clonar repositorio para un repositorio de código fuente.

  5. Guarde el secreto del PAT en un lugar seguro.

    importante

    El secreto del PAT solo se muestra una vez. No podrá recuperarlo después de cerrar la ventana.

Colocación del PAT en un archivo independiente
  1. Actualice el archivo build.gradle con el siguiente fragmento: Sustituya space_name, proj_name y repo_name por el nombre de usuario, el nombre del espacio, el nombre del proyecto y el nombre del repositorio de paquetes en CodeCatalyst.

    def props = new Properties() file("fileName").withInputStream { props.load(it) } repositories { maven { name = 'spaceName' url = uri('https://packages.region.codecatalyst.aws/maven/space_name/proj_name/repo_name/') credentials(PasswordCredentials) } } }
  2. Escriba el PAT en el archivo especificado en su archivo build.gradle:

    echo "codecatalystArtifactsToken=PAT" > fileName