Configurer RubyGems et utiliser un Bundler avec CodeArtifact

1. Ouvrez la AWS CodeArtifact console sur https://console.aws.amazon.com/codesuite/codeartifact/home.

2. Dans le volet de navigation, choisissez Repositories, puis choisissez le référentiel que vous souhaitez utiliser pour installer ou diffuser des gemmes Ruby.

3. Choisissez Afficher les instructions de connexion.

4. Choisissez votre système d'exploitation.

5. Choisissez le client du gestionnaire de packages Ruby que vous souhaitez configurer avec votre CodeArtifact dépôt.

6. Suivez les instructions générées pour configurer le client du gestionnaire de packages afin d'installer des gemmes Ruby ou de publier des gemmes Ruby dans le référentiel.

1. Dans une ligne de commande, utilisez la commande suivante pour récupérer un jeton CodeArtifact d'autorisation et le stocker dans une variable d'environnement.

   • my_domainRemplacez-le par votre nom de CodeArtifact domaine.

   • Remplacez 111122223333 par le numéro de AWS compte du propriétaire du domaine. Si vous accédez à un référentiel dans un domaine qui vous appartient, vous n'avez pas besoin de l'inclure--domain-owner. Pour de plus amples informations, veuillez consulter Domaines multi-comptes.

   macOS and Linux

   export CODEARTIFACT_AUTH_TOKEN=`aws codeartifact get-authorization-token --domain my_domain --domain-owner 111122223333 --query authorizationToken --output text`

   Windows

   • Windows (en utilisant l'interface de commande par défaut) :

     for /f %i in ('aws codeartifact get-authorization-token --domain my_domain --domain-owner 111122223333 --query authorizationToken --output text') do set CODEARTIFACT_AUTH_TOKEN=%i

   • Fenêtres PowerShell :

     $env:CODEARTIFACT_AUTH_TOKEN = aws codeartifact get-authorization-token --domain my_domain --domain-owner 111122223333 --query authorizationToken --output text

2. Pour publier des gemmes Ruby dans votre dépôt, utilisez la commande suivante pour récupérer le point de terminaison de votre CodeArtifact dépôt et le stocker dans la variable d'RUBYGEMS_HOSTenvironnement. La gem CLI utilise cette variable d'environnement pour déterminer où les gemmes sont publiées.

   Note

   Au lieu d'utiliser la variable d'RUBYGEMS_HOSTenvironnement, vous pouvez également fournir --host cette option au point de terminaison du référentiel lorsque vous utilisez la gem push commande.

   • my_domainRemplacez-le par votre nom de CodeArtifact domaine.

   • Remplacez 111122223333 par le numéro de AWS compte du propriétaire du domaine. Si vous accédez à un référentiel dans un domaine qui vous appartient, vous n'avez pas besoin de l'inclure--domain-owner. Pour de plus amples informations, veuillez consulter Domaines multi-comptes.

   • my_repoRemplacez-le par le nom de votre CodeArtifact dépôt.

   macOS and Linux

   export RUBYGEMS_HOST=`aws codeartifact get-repository-endpoint --domain my_domain --domain-owner 111122223333 --repository my_repo --format ruby --query repositoryEndpoint --output text | sed 's:/*$::'`

   Windows

   Les commandes suivantes permettent de récupérer le point de terminaison du référentiel, de découper le point final/, puis de le stocker dans une variable d'environnement.

   • Windows (en utilisant l'interface de commande par défaut) :

     for /f %i in ('aws codeartifact get-repository-endpoint --domain my_domain --domain-owner 111122223333 --repository my_repo --format ruby --query repositoryEndpoint --output text') do set RUBYGEMS_HOST=%i
                                     
     set RUBYGEMS_HOST=%RUBYGEMS_HOST:~0,-1%

   • Fenêtres PowerShell :

     $env:RUBYGEMS_HOST = (aws codeartifact get-repository-endpoint --domain my_domain --domain-owner 111122223333 --repository my_repo --format ruby --query repositoryEndpoint --output text).TrimEnd("/")

   L'URL suivante est un exemple de point de terminaison du référentiel :

   https://my_domain-111122223333.d.codeartifact.us-west-2.amazonaws.com/ruby/my_repo/

   Note

   Pour utiliser un point de terminaison à double pile, utilisez le codeartifact.region.on.aws point de terminaison.

3. Pour publier des gemmes Ruby dans votre dépôt, vous devez vous authentifier auprès de CodeArtifact with RubyGems en éditant votre ~/.gem/credentials fichier pour inclure votre jeton d'authentification. Créez un ~/.gem/ répertoire et un ~/.gem/credentials fichier si le répertoire ou le fichier n'existe pas.

   macOS and Linux

   echo ":codeartifact_api_key: Bearer $CODEARTIFACT_AUTH_TOKEN" >> ~/.gem/credentials

   Windows

   • Windows (en utilisant l'interface de commande par défaut) :

     echo :codeartifact_api_key: Bearer %CODEARTIFACT_AUTH_TOKEN% >> %USERPROFILE%/.gem/credentials

   • Fenêtres PowerShell :

     echo ":codeartifact_api_key: Bearer $env:CODEARTIFACT_AUTH_TOKEN" | Add-Content ~/.gem/credentials

4. gemPour installer des gemmes Ruby depuis votre dépôt, vous devez ajouter les informations de point de terminaison du référentiel et le jeton d'authentification à votre .gemrc fichier. Vous pouvez l'ajouter au fichier global (~/.gemrc) ou à votre .gemrc fichier de projet. Les CodeArtifact informations que vous devez y ajouter .gemrc sont une combinaison du point de terminaison du référentiel et du jeton d'authentification. Il est formaté comme suit :

   https://aws:${CODEARTIFACT_AUTH_TOKEN}@my_domain-111122223333.d.codeartifact.us-west-2.amazonaws.com/ruby/my_repo/

   • Pour le jeton d'authentification, vous pouvez utiliser la variable d'CODEARTIFACT_AUTH_TOKENenvironnement définie lors d'une étape précédente.

   • Pour récupérer le point de terminaison du référentiel, vous pouvez lire la valeur de la variable d'RUBYGEMS_HOSTenvironnement définie précédemment, ou vous pouvez utiliser la get-repository-endpoint commande suivante, en remplaçant les valeurs si nécessaire :

     aws codeartifact get-repository-endpoint --domain my_domain --domain-owner 111122223333 --repository my_repo --format ruby --query repositoryEndpoint --output text

   Une fois que vous avez le point final, utilisez un éditeur de texte pour l'ajouter aws:${CODEARTIFACT_AUTH_TOKEN}@ à la position appropriée. Une fois que vous avez créé le point de terminaison du référentiel et la chaîne du jeton d'authentification, ajoutez-les à la :sources: section de votre .gemrc fichier à l'aide de la echo commande suivante :

   Avertissement

   CodeArtifact ne prend pas en charge l'ajout de référentiels en tant que sources à l'aide de la gem sources -add commande. Vous devez ajouter la source directement dans le fichier.

   macOS and Linux

   echo ":sources:
       - https://aws:${CODEARTIFACT_AUTH_TOKEN}@my_domain-111122223333.d.codeartifact.us-west-2.amazonaws.com/ruby/my_repo/" > ~/.gemrc

   Windows

   • Windows (en utilisant l'interface de commande par défaut) :

     echo ":sources:
         - https://aws:%CODEARTIFACT_AUTH_TOKEN%@my_domain-111122223333.d.codeartifact.us-west-2.amazonaws.com/ruby/my_repo/" > "%USERPROFILE%\.gemrc"

   • Fenêtres PowerShell :

     echo ":sources:
         - https://aws:$env:CODEARTIFACT_AUTH_TOKEN@my_domain-111122223333.d.codeartifact.us-west-2.amazonaws.com/ruby/my_repo/" | Add-Content ~/.gemrc

5. Pour utiliser Bundler, vous devez configurer Bundler avec l'URL du point de terminaison et le jeton d'authentification de votre référentiel en exécutant la commande suivante : bundle config

   macOS and Linux

   bundle config $RUBYGEMS_HOST aws:$CODEARTIFACT_AUTH_TOKEN 

   Windows

   • Windows (en utilisant l'interface de commande par défaut) :

     bundle config %RUBYGEMS_HOST% aws:%CODEARTIFACT_AUTH_TOKEN%

   • Fenêtres PowerShell :

     bundle config $Env:RUBYGEMS_HOST aws:$Env:CODEARTIFACT_AUTH_TOKEN

Pour installer des gemmes Ruby à partir d'un CodeArtifact dépôt avec gem

1. Si ce n'est pas le cas, suivez les étapes décrites Configure RubyGems (gem) et Bundler (bundle) avec CodeArtifact pour configurer la gem CLI afin d'utiliser votre CodeArtifact référentiel avec les informations d'identification appropriées.

   Note

   Le jeton d'autorisation généré est valide pendant 12 heures. Vous devrez en créer un nouveau si 12 heures se sont écoulées depuis la création du jeton.

2. Utilisez la commande suivante pour installer les gemmes Ruby depuis CodeArtifact :

   gem install my_ruby_gem --version 1.0.0

Pour installer des gemmes Ruby à partir d'un CodeArtifact dépôt avec bundle

1. Si ce n'est pas le cas, suivez les étapes décrites Configure RubyGems (gem) et Bundler (bundle) avec CodeArtifact pour configurer la bundle CLI afin d'utiliser votre CodeArtifact référentiel avec les informations d'identification appropriées.

   Note

   Le jeton d'autorisation généré est valide pendant 12 heures. Vous devrez en créer un nouveau si 12 heures se sont écoulées depuis la création du jeton.

2. Ajoutez l'URL du point de terminaison de votre CodeArtifact dépôt à votre Gemfile adresse source pour installer des gemmes Ruby configurées à partir de votre CodeArtifact référentiel et de ses flux en amont.

   source "https://my_domain-111122223333.d.codeartifact.us-west-2.amazonaws.com/ruby/my_repo/"
                   
   gem 'my_ruby_gem'

3. Utilisez la commande suivante pour installer les gemmes Ruby comme indiqué dans votre Gemfile :

   bundle install

1. Si ce n'est pas le cas, suivez les étapes décrites Configure RubyGems (gem) et Bundler (bundle) avec CodeArtifact pour configurer la gem CLI afin d'utiliser votre CodeArtifact référentiel avec les informations d'identification appropriées.

   Note

   Le jeton d'autorisation généré est valide pendant 12 heures. Vous devrez en créer un nouveau si 12 heures se sont écoulées depuis la création du jeton.

2. Utilisez la commande suivante pour publier des gemmes Ruby dans un CodeArtifact dépôt. Notez que si vous n'avez pas défini la variable d'RUBYGEMS_HOSTenvironnement, vous devez indiquer le point de terminaison de votre CodeArtifact référentiel dans l'--hostoption.

   gem push --key codeartifact_api_key my_ruby_gem-0.0.1.gem