Configuration et utilisation de Gradle Groovy - Amazon CodeCatalyst

Les traductions sont fournies par des outils de traduction automatique. En cas de conflit entre le contenu d'une traduction et celui de la version originale en anglais, la version anglaise prévaudra.

Configuration et utilisation de Gradle Groovy

Pour utiliser Gradle Groovy avec CodeCatalyst, vous devez connecter Gradle Groovy à votre référentiel de packages et fournir un jeton d'accès personnel (PAT) pour l'authentification. Vous pouvez consulter les instructions pour connecter Gradle Groovy à votre référentiel de packages dans la console. CodeCatalyst

Récupération des dépendances depuis CodeCatalyst

Les instructions suivantes expliquent comment configurer Gradle Groovy pour récupérer les dépendances de votre référentiel de packages. CodeCatalyst

Pour utiliser Gradle Groovy pour récupérer les dépendances de votre référentiel de packages CodeCatalyst
  1. Ouvrez la CodeCatalyst console à l'adresse https://codecatalyst.aws/.

  2. Accédez à votre projet.

  3. Dans le panneau de navigation, choisissez Packages.

  4. Choisissez votre référentiel de packages dans la liste des référentiels de packages.

  5. Choisissez Connect to repository.

  6. Dans la boîte de dialogue Connect to repository, choisissez Gradle Groovy dans la liste des clients du gestionnaire de packages.

  7. Vous aurez besoin d'un jeton d'accès personnel (PAT) pour authentifier Gradle Groovy. CodeCatalyst Si vous en avez déjà un, vous pouvez l'utiliser. Si ce n'est pas le cas, vous pouvez en créer un ici.

    1. Choisissez Créer un jeton.

    2. Choisissez Copier pour copier votre PAT.

      Avertissement

      Vous ne pourrez plus voir ou copier votre PAT une fois que vous aurez fermé la boîte de dialogue.

  8. Mettez à jour votre fichier de propriétés Gradle avec vos identifiants d'accès. Remplacez le nom d' CodeCatalyst utilisateur par votre nom d'utilisateur et remplacez PAT par votre jeton d'accès CodeCatalyst personnel. Vous pouvez utiliser n'importe quelle valeur pour SpaceUserName et SpacePassword, à condition d'utiliser les mêmes valeurs dans les étapes suivantes.

    spaceUsername=username spacePassword=PAT
  9. Pour récupérer les dépendances CodeCatalyst dans une version Gradle, copiez l'extrait de maven code et ajoutez-le à la repositories section du fichier de votre projet. build.gradle Remplacez les valeurs suivantes. Vous pouvez utiliser n'importe quelle valeur pour SpaceName, à condition d'utiliser les mêmes valeurs dans les étapes suivantes.

    Note

    Si vous copiez les instructions depuis la console, les valeurs suivantes doivent être mises à jour pour vous et ne doivent pas être modifiées.

    • Remplacez space_name par le nom de votre CodeCatalyst espace.

    • Remplacez proj_name par le nom de votre CodeCatalyst projet.

    • Remplacez repo_name par le nom CodeCatalyst du dépôt de votre package.

    maven { name = 'spaceName' url = uri('https://packages.region.codecatalyst.aws/maven/space_name/proj_name/repo_name/') credentials(PasswordCredentials) }
  10. (Facultatif) Pour utiliser le référentiel de CodeCatalyst packages comme seule source pour les dépendances de votre projet, supprimez du build.gradle fichier toutes les autres sections des référentiels. Si vous avez plusieurs référentiels, Gradle recherche les dépendances dans chaque référentiel dans l'ordre dans lequel elles sont répertoriées.

Récupération de plugins depuis CodeCatalyst

Par défaut, Gradle résoudra les plugins à partir du portail public des plugins Gradle. Les étapes suivantes configurent votre projet Gradle pour résoudre les plugins à partir de votre référentiel de CodeCatalyst packages.

Pour utiliser Gradle pour récupérer des plugins depuis votre référentiel de packages CodeCatalyst
  1. Ouvrez la CodeCatalyst console à l'adresse https://codecatalyst.aws/.

  2. Accédez à votre projet.

  3. Dans le panneau de navigation, choisissez Packages.

  4. Choisissez votre référentiel de packages dans la liste des référentiels de packages.

  5. Choisissez Connect to repository.

  6. Dans la boîte de dialogue Connect to repository, choisissez Gradle dans la liste des clients du gestionnaire de packages.

  7. Vous aurez besoin d'un jeton d'accès personnel (PAT) pour authentifier Gradle. CodeCatalyst Si vous en avez déjà un, vous pouvez l'utiliser. Si ce n'est pas le cas, vous pouvez en créer un ici.

    1. Choisissez Créer un jeton.

    2. Choisissez Copier pour copier votre PAT.

      Avertissement

      Vous ne pourrez plus voir ou copier votre PAT une fois que vous aurez fermé la boîte de dialogue.

  8. Mettez à jour votre fichier de propriétés Gradle avec vos identifiants d'accès. Remplacez le nom d' CodeCatalyst utilisateur par votre nom d'utilisateur et remplacez PAT par votre jeton d'accès CodeCatalyst personnel. Vous pouvez utiliser n'importe quelle valeur pour SpaceUserName et SpacePassword, à condition d'utiliser les mêmes valeurs dans les étapes suivantes.

    spaceUsername=username spacePassword=PAT
  9. Ajoutez un pluginManagement bloc à votre settings.gradle fichier. Le pluginManagement bloc doit apparaître avant toute autre instruction danssettings.gradle. Remplacez les valeurs suivantes.

    Note

    Si vous copiez les instructions depuis la console, les valeurs suivantes doivent être mises à jour pour vous et ne doivent pas être modifiées.

    • Remplacez SpaceName par la valeur du nom utilisée à l'étape précédente.

    • Remplacez space_name par le nom de votre CodeCatalyst espace.

    • Remplacez proj_name par le nom de votre CodeCatalyst projet.

    • Remplacez repo_name par le nom CodeCatalyst du dépôt de votre package.

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

    Cela garantira que Gradle résout les plugins à partir du référentiel spécifié. Le référentiel doit avoir une connexion en amont configurée avec le portail des plugins Gradle (gradle-plugins-store) afin que les plugins Gradle couramment requis soient disponibles pour la compilation. Pour plus d'informations, consultez la documentation Gradle.

Récupération de packages depuis des référentiels de packages externes via CodeCatalyst

Vous pouvez installer des packages Maven à partir de référentiels publics via un CodeCatalyst référentiel en le configurant avec une connexion en amont à la passerelle qui représente le référentiel de passerelle. Les packages installés à partir du référentiel de passerelle sont ingérés et stockés dans votre CodeCatalyst référentiel.

CodeCatalyst prend en charge les référentiels publics de packages Maven suivants.

  • maven-central-gateway

  • google-android-gateway

  • gradle-plugins-gateway

  • passerelle commonware

Pour installer des packages à partir de référentiels de packages Maven publics
  1. Si ce n'est pas déjà fait, configurez Gradle avec votre référentiel de CodeCatalyst packages en suivant les étapes décrites dans Récupération des dépendances depuis CodeCatalyst ouRécupération de plugins depuis CodeCatalyst.

  2. Assurez-vous que votre référentiel a ajouté le référentiel de passerelle à partir duquel vous souhaitez effectuer l'installation en tant que connexion en amont. Vous pouvez le faire en suivant les instructions fournies Ajouter un référentiel en amont et en choisissant le référentiel public de packages que vous souhaitez ajouter en amont.

Pour plus d'informations sur la demande de packages à partir de référentiels en amont, consultezDemande d'une version de package avec des référentiels en amont.

Publier des packages vers CodeCatalyst

Cette section décrit comment publier une bibliothèque Java créée avec Gradle Groovy dans un référentiel. CodeCatalyst

Pour utiliser Gradle Groovy pour publier des packages dans un référentiel de packages CodeCatalyst
  1. Ouvrez la CodeCatalyst console à l'adresse https://codecatalyst.aws/.

  2. Sur la page d'aperçu de votre projet, sélectionnez Packages.

  3. Choisissez votre référentiel de packages dans la liste des référentiels de packages.

  4. Choisissez Connect to repository.

  5. Dans la boîte de dialogue Connect to repository, choisissez Gradle Groovy dans la liste des clients du gestionnaire de packages.

  6. Vous aurez besoin d'un jeton d'accès personnel (PAT) pour authentifier Gradle. CodeCatalyst Si vous en avez déjà un, vous pouvez l'utiliser. Si ce n'est pas le cas, vous pouvez en créer un ici.

    1. Choisissez Créer un jeton.

    2. Choisissez Copier pour copier votre PAT.

      Avertissement

      Vous ne pourrez plus voir ou copier votre PAT une fois que vous aurez fermé la boîte de dialogue.

  7. Mettez à jour votre fichier de propriétés Gradle avec vos identifiants d'accès. Remplacez le nom d' CodeCatalyst utilisateur par votre nom d'utilisateur et remplacez PAT par votre jeton d'accès CodeCatalyst personnel. Vous pouvez utiliser n'importe quelle valeur pour SpaceUserName et SpacePassword, à condition d'utiliser les mêmes valeurs dans les étapes suivantes.

    spaceUsername=username spacePassword=PAT
  8. Ajoutez le maven-publish plugin à la plugins section du build.gradle fichier du projet.

    plugins { id 'java-library' id 'maven-publish' }
  9. Ajoutez ensuite une publishing section au build.gradle fichier de projet. Remplacez les valeurs suivantes.

    Note

    Si vous copiez les instructions depuis la console, les valeurs suivantes doivent être mises à jour pour vous et ne doivent pas être modifiées.

    • Remplacez space_name par le nom de votre CodeCatalyst espace.

    • Remplacez proj_name par le nom de votre CodeCatalyst projet.

    • Remplacez repo_name par le nom CodeCatalyst du dépôt de votre package.

    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) } } }

    Le maven-publish plugin génère un fichier POM basé sur le groupIdartifactId, et version spécifié dans la publishing section.

  10. Une fois ces modifications build.gradle terminées, exécutez la commande suivante pour créer le projet et le télécharger dans le référentiel.

    ./gradlew publish
  11. Accédez à votre référentiel de packages dans la CodeCatalyst console pour vérifier que le package a bien été publié. Vous devriez voir le package dans la liste des packages de votre référentiel de packages.

Pour plus d'informations, consultez les rubriques suivantes sur le site Web de Gradle :

Exécution d'une version Gradle dans IntelliJ IDEA

Vous pouvez exécuter une version Gradle dans IntelliJ IDEA qui extrait les dépendances de. CodeCatalyst Pour authentifier Gradle auprès de Gradle CodeCatalyst, vous devez utiliser un jeton d'accès personnel (PAT). Vous pouvez enregistrer votre CodeCatalyst PAT dans un fichier séparé de votre choix gradle.properties ou dans un fichier séparé.

Méthode 1 : insérez le PAT gradle.properties

Utilisez cette méthode si vous n'utilisez pas le gradle.properties fichier et que vous pouvez remplacer son contenu par votre PAT. Si vous l'utilisezgradle.properties, vous pouvez modifier cette méthode pour ajouter le PAT au lieu de remplacer le contenu du fichier.

Note

L'exemple montre le gradle.properties fichier situé dansGRADLE_USER_HOME.

Créez d'abord un PAT si vous n'en avez pas.

Pour créer un jeton d'accès personnel (PAT)
  1. Dans la barre de menu supérieure, choisissez votre badge de profil, puis sélectionnez Mes paramètres.

    Astuce

    Vous pouvez également accéder à votre profil utilisateur en vous rendant sur la page des membres d'un projet ou d'un espace et en choisissant votre nom dans la liste des membres.

  2. Dans Nom du PAT, entrez un nom descriptif pour votre PAT.

  3. Dans Date d'expiration, laissez la date par défaut ou cliquez sur l'icône du calendrier pour sélectionner une date personnalisée. La date d'expiration par défaut est d'un an à compter de la date actuelle.

  4. Choisissez Créer.

    Vous pouvez également créer ce jeton lorsque vous choisissez Clone un référentiel pour un référentiel source.

  5. Enregistrez le secret PAT dans un emplacement sécurisé.

    Important

    Le secret PAT ne s'affiche qu'une seule fois. Vous ne pouvez pas le récupérer après avoir fermé la fenêtre.

Ensuite, mettez à jour votre build.gradle fichier avec l'extrait de code suivant :

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

Méthode 2 : Placer le PAT dans un fichier séparé

Utilisez cette méthode si vous ne souhaitez pas modifier votre gradle.properties fichier.

Créez d'abord un PAT si vous n'en avez pas.

Pour créer un jeton d'accès personnel (PAT)
  1. Dans la barre de menu supérieure, choisissez votre badge de profil, puis sélectionnez Mes paramètres.

    Astuce

    Vous pouvez également accéder à votre profil utilisateur en vous rendant sur la page des membres d'un projet ou d'un espace et en choisissant votre nom dans la liste des membres.

  2. Dans Nom du PAT, entrez un nom descriptif pour votre PAT.

  3. Dans Date d'expiration, laissez la date par défaut ou cliquez sur l'icône du calendrier pour sélectionner une date personnalisée. La date d'expiration par défaut est d'un an à compter de la date actuelle.

  4. Choisissez Créer.

    Vous pouvez également créer ce jeton lorsque vous choisissez Clone un référentiel pour un référentiel source.

  5. Enregistrez le secret PAT dans un emplacement sécurisé.

    Important

    Le secret PAT ne s'affiche qu'une seule fois. Vous ne pouvez pas le récupérer après avoir fermé la fenêtre.

Pour placer votre PAT dans un fichier séparé
  1. Mettez à jour votre build.gradle fichier avec l'extrait suivant. Remplacez space_name, proj_name et repo_name par votre nom d' CodeCatalyst utilisateur, le nom de l'espace, le nom du projet et le nom du dépôt de packages.

    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. Écrivez votre PAT dans le fichier qui a été spécifié dans votre build.gradle fichier :

    echo "codecatalystArtifactsToken=PAT" > fileName