View a markdown version of this page

GitHub et jeton d'accès GitHub Enterprise Server - AWS CodeBuild
Prérequis de jeton d'accèsConnectez-vous à GitHub l'aide d'un jeton d'accès (console)Connectez-vous à GitHub l'aide d'un jeton d'accès (CLI)

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.

GitHub et jeton d'accès GitHub Enterprise Server

Prérequis de jeton d'accès

Avant de commencer, vous devez ajouter les étendues d'autorisation appropriées à votre jeton GitHub d'accès.

Pour GitHub, votre jeton d'accès personnel doit avoir les étendues suivantes.

  • repo : accorde un contrôle total des référentiels privés.

  • repo:status  : donne read/write accès aux statuts de validation des référentiels publics et privés.

  • admin:repo_hook : accorde le contrôle total des hooks de référentiel. Cette règle n'est pas obligatoire si votre jeton dispose de la règle repo.

  • admin:org_hook  : confère le contrôle total des hooks d'organisation. Cette étendue n'est requise que si vous utilisez la fonctionnalité de webhook de l'organisation.

Pour plus d'informations, consultez la section Comprendre les domaines d'application des applications OAuth sur le site Web. GitHub

Si vous utilisez des jetons d'accès personnels précis, selon votre cas d'utilisation, votre jeton d'accès personnel peut nécessiter les autorisations suivantes :

  • Contenu Read-only  : Donne accès à des dépôts privés. Cette autorisation est requise si vous utilisez des référentiels privés comme source.

  • Statuts de validation : Lecture et écriture  : autorise la création de statuts de validation. Cette autorisation est requise si le webhook est configuré pour votre projet ou si la fonctionnalité d'état de création du rapport est activée.

  • Webhooks : lecture et écriture  : autorise la gestion des webhooks. Cette autorisation est requise si un webhook est configuré pour votre projet.

  • Pull requests Read-only  : autorise l'accès aux pull requests. Cette autorisation est requise si votre webhook possède un FILE_PATH filtre sur les événements de pull request.

  • Administration : lecture et écriture  : cette autorisation est requise si vous utilisez la fonctionnalité auto-hébergée GitHub Actions runner avec CodeBuild. Pour plus de détails, voir Créer un jeton d'enregistrement pour un référentiel etTutoriel : Configuration d'un lanceur d' CodeBuild-hosted GitHub actions.

Note

Si vous souhaitez accéder aux référentiels de l'organisation, assurez-vous de spécifier l'organisation en tant que propriétaire de la ressource du jeton d'accès.

Pour plus d'informations, consultez Autorisations requises pour les jetons d'accès personnels affinés sur le GitHub site Web.

Connectez-vous à GitHub l'aide d'un jeton d'accès (console)

Pour utiliser la console pour connecter votre projet à GitHub l'aide d'un jeton d'accès, procédez comme suit lorsque vous créez un projet. Pour plus d'informations, consultez Création d'un projet de génération (console).

  1. Pour Fournisseur source, sélectionnez GitHub.

  2. Pour les informations d'identification, effectuez l'une des opérations suivantes :

    • Choisissez d'utiliser les informations d'identification du compte pour appliquer les informations d'identification source par défaut de votre compte à tous les projets.

      1. Si vous n'êtes pas connecté à GitHub, choisissez Gérer les informations d'identification du compte.

      2. Pour Type d'identification, choisissez Jeton d'accès personnel.

    • Si vous avez choisi d'utiliser les informations d'identification au niveau du compte pour le Service, choisissez le service que vous souhaitez utiliser pour stocker votre jeton et procédez comme suit :

      1. Si vous choisissez d'utiliser le Gestionnaire de secrets, vous pouvez choisir d'utiliser une connexion secrète existante ou de créer un nouveau secret, puis choisir Enregistrer. Pour plus d'informations sur la création d'un nouveau secret, consultezCréez et stockez un jeton dans un secret de Secrets Manager.

      2. Si vous choisissez de l'utiliser CodeBuild, entrez votre jeton d'accès GitHub personnel, puis choisissez Enregistrer.

    • Sélectionnez Utiliser les informations d'identification de remplacement pour ce projet uniquement pour utiliser une identification source personnalisée afin de modifier les paramètres d'identification de votre compte.

      1. Dans la liste des informations d'identification remplie, choisissez l'une des options sous Jeton d'accès personnel.

      2. Vous pouvez également créer un nouveau jeton d'accès personnel en sélectionnant Créer une nouvelle connexion par jeton d'accès personnel dans la description.

Connectez-vous à GitHub l'aide d'un jeton d'accès (CLI)

Suivez ces étapes pour connecter votre projet AWS CLI à l' GitHub aide d'un jeton d'accès. Pour plus d'informations sur l'utilisation AWS CLI de with AWS CodeBuild, consultez leRéférence des commandes en ligne.

  1. Exécutez la commande import-source-credentials : 

    aws codebuild import-source-credentials --generate-cli-skeleton

    JSON-formatted les données apparaissent dans la sortie. Copiez les données dans un fichier (par exempleimport-source-credentials.json) situé à un emplacement de l'ordinateur local ou de l'instance sur laquelle le AWS CLI est installé. Modifiez les données copiées comme suit, puis enregistrez vos résultats. 

    {
    "serverType": "server-type",
    "authType": "auth-type",
    "shouldOverwrite": "should-overwrite",
    "token": "token",
    "username": "username"
    }

    Remplacez les éléments suivants :

    • server-type: valeur obligatoire. Le fournisseur de source utilisé pour cette information d'identification. Les valeurs valides sont GITHUB, BITBUCKET, GITHUB_ENTERPRISE, GITLAB et GITLAB_SELF_MANAGED.

    • auth-type: valeur obligatoire. Type d'authentification utilisé pour se connecter à un référentiel. Les valeurs valides sont OAUTH, BASIC_AUTH, PERSONAL_ACCESS_TOKEN, CODECONNECTIONS et SECRETS_MANAGER. Pour GitHub, seul PERSONAL_ACCESS_TOKEN est autorisé. BASIC_AUTH n'est autorisé qu'avec le mot de passe ou le jeton d'API de l'application Bitbucket.

    • should-overwrite: valeur facultative. Définissez cette valeur sur false pour empêcher le remplacement des informations d'identification source du référentiel. Définissez cette valeur sur true pour remplacer les informations d'identification source du référentiel. La valeur par défaut est true.

    • token: valeur obligatoire. Pour GitHub notre GitHub Enterprise Server, il s'agit du jeton d'accès personnel. Pour Bitbucket, il s'agit du jeton d'accès personnel, du mot de passe de l'application ou du jeton d'API. Pour le type d'authentification CODECONNECTIONS, il s'agit de l'ARN de connexion. Pour le type d'authentification SECRETS_MANAGER, il s'agit de l'ARN secret.

    • username: valeur facultative. Ce paramètre est ignoré pour GitHub les fournisseurs de sources GitHub Enterprise Server. Pour le mot de passe d'une application Bitbucket, il s'agit de votre nom d'utilisateur Bitbucket. Pour un jeton d'API Bitbucket, il s'agit de l'adresse e-mail associée à votre compte Atlassian.

  2. Pour vous connecter à votre compte avec un jeton d'accès, passez au répertoire contenant le fichier import-source-credentials.json que vous avez enregistré à l'étape 1 et exécutez à nouveau la commande import-source-credentials. 

    aws codebuild import-source-credentials --cli-input-json file://import-source-credentials.json

    JSON-formatted les données apparaissent dans la sortie avec un Amazon Resource Name (ARN). 

    {
    "arn": "arn:aws:codebuild:region:account-id:token/server-type"
    }
    Note

    Si vous exécutez la commande import-source-credentials avec le même type de serveur et de auth une seconde fois, le jeton d'accès stocké est mis à jour.

    Une fois que votre compte est connecté à un jeton d'accès, vous pouvez l'utiliser create-project pour créer votre CodeBuild projet. Pour de plus amples informations, veuillez consulter Créez un projet de construction (AWS CLI).

  3. Pour afficher les jetons d'accès connectés, exécutez la commande list-source-credentials. 

    aws codebuild list-source-credentials

    Un JSON-formatted sourceCredentialsInfos objet apparaît dans la sortie : 

    {
        "sourceCredentialsInfos": [
            {
                "authType": "auth-type",
                "serverType": "server-type", 
                "arn": "arn"
            }
        ]
    }

    Le sourceCredentialsObject contient la liste des informations d'identification de la source connectée :

    • L'élément authType est le type d'authentification utilisé par les informations d'identification. Cela peut être OAUTHBASIC_AUTH, PERSONAL_ACCESS_TOKENCODECONNECTIONS, ouSECRETS_MANAGER.

    • Le serverType est le type de fournisseur de source. Cela peut être GITHUBGITHUB_ENTERPRISE, BITBUCKETGITLAB, ouGITLAB_SELF_MANAGED.

    • Le arn est l'ARN du jeton.

  4. Pour vous déconnecter d'un fournisseur de source et supprimer ses jetons d'accès, exécutez la commande delete-source-credentials avec son ARN. 

    aws codebuild delete-source-credentials --arn arn-of-your-credentials

    JSON-formatted les données sont renvoyées avec un ARN des informations d'identification supprimées. 

    {
    "arn": "arn:aws:codebuild:region:account-id:token/server-type"
    }