Utilisation des types d'action

Pour enregistrer une demande d'intégration Lambda

• Envoyez une demande à l'équipe CodePipeline de service en utilisant le formulaire suivant.

  This issue will track the onboarding of [Name] in CodePipeline.
  
  
  [Contact engineer] will be the primary point of contact for this integration.
  
  Name of the action type as you want it to appear to customers: Example.com Testing
  
  Initial onboard checklist:
  
  1. Attach an action type definition file in JSON format. This includes the schema for the action type
  
  2. A list of test accounts for the allowlist which can access the new action type [{account, account_name}]
  
  3. The Lambda function ARN
  
  4. List of Régions AWS where your action will be available
  
  5. Will this be available as a public action?
  

Pour enregistrer une demande d'intégration d'un travailleur

• Envoyez une demande à l'équipe CodePipeline de service en utilisant le formulaire suivant.

  This issue will track the onboarding of [Name] in CodePipeline.
  
  [Contact engineer] will be the primary point of contact for this integration.
  
  
  Name of the action type as you want it to appear to customers: Example.com Testing
  
  Initial onboard checklist:
  
  1. Attach an action type definition file in JSON format. This includes the schema for the action type.
  
  2. A list of test accounts for the allowlist which can access the new action type [{account, account_name}]
  
  3. URL information:
  Website URL: https://www.example.com/%TestThirdPartyName%/%TestVersionNumber%
  
  Example URL pattern where customers will be able to review their configuration information for the action: https://www.example.com/%TestThirdPartyName%/%customer-ID%/%CustomerActionConfiguration%
  
  Example runtime URL pattern: https://www.example.com/%TestThirdPartyName%/%customer-ID%/%TestRunId%
  
  4. List of Régions AWS where your action will be available
  
  5. Will this be available as a public action?

Pour ajouter votre type d'action à un pipeline existant depuis la CodePipeline console

1. Connectez-vous à la CodePipeline console AWS Management Console et ouvrez-la à l'adresse http://console.aws.amazon.com/codesuite/codepipeline/home.

2. Dans la liste des pipelines, choisissez le pipeline dans lequel vous souhaitez ajouter le type d'action.

3. Sur la page d'affichage récapitulatif du pipeline, choisissez Modifier.

4. Choisissez de modifier l'étape. À l'étape où vous souhaitez ajouter votre type d'action, choisissez Ajouter un groupe d'actions. La page Modifier l'action s'affiche.

5. Sur la page Modifier l'action, dans Nom de l'action, entrez le nom de l'action. Il s'agit du nom qui s'affiche pour l'étape de votre pipeline.

6. Dans Fournisseur d'actions, choisissez votre type d'action dans la liste.

   Notez que la valeur de la liste est basée sur celle provider spécifiée dans le fichier de définition du type d'action.

7. Dans Artefacts d'entrée, entrez le nom de l'artefact au format suivant :

   Artifactname::FileName

   Notez que les quantités minimales et maximales autorisées sont définies en fonction de celles inputArtifactDetails spécifiées dans le fichier de définition du type d'action.

8. Choisissez Connect to<Action_Name>.

   Une fenêtre de navigateur s'ouvre et se connecte au site Web que vous avez créé pour votre type d'action.

9. Connectez-vous à votre site Web en tant que client et suivez les étapes suivies par un client pour utiliser votre type d'action. Vos étapes varient en fonction de votre catégorie d'action, de votre site Web et de votre configuration, mais elles incluent généralement une action d'achèvement qui renvoie le client à la page Modifier l'action.

10. Dans la page CodePipeline Modifier l'action, les champs de configuration supplémentaires pour l'action s'affichent. Les champs qui s'affichent correspondent aux propriétés de configuration que vous avez spécifiées dans le fichier de définition d'action. Entrez les informations dans les champs personnalisés pour votre type d'action.

    Par exemple, si le fichier de définition d'action spécifie une propriété nomméeHost, un champ portant le libellé Hôte s'affiche sur la page Modifier l'action correspondant à votre action.

11. Dans Artefacts de sortie, entrez le nom de l'artefact au format suivant :

    Artifactname::FileName

    Notez que les quantités minimales et maximales autorisées sont définies en fonction de celles outputArtifactDetails spécifiées dans le fichier de définition du type d'action.

12. Choisissez Terminé pour revenir à la page des détails du pipeline.

    Note

    Vos clients peuvent éventuellement utiliser la CLI pour ajouter le type d'action à leur pipeline.

13. Pour tester votre action, validez une modification de la source spécifiée dans l'étape source du pipeline ou suivez les étapes décrites dans Démarrer manuellement un pipeline.

Pour afficher un type d'action

1. Créez un fichier JSON d'entrée et nommez-lefile.json. Ajoutez votre identifiant de type d'action au format JSON, comme indiqué dans l'exemple suivant.

   {
       "category": "Test",
       "owner": "ThirdParty",
       "provider": "TestProvider",
       "version": "1"
   }

2. Dans une fenêtre de terminal ou sur la ligne de commande, exécutez la get-action-type commande.

   aws codepipeline get-action-type --cli-input-json file://file.json

   Cette commande renvoie la sortie de définition d'action pour un type d'action. Cet exemple montre un type d'action créé avec le modèle d'intégration Lambda.

   {
       "actionType": {
           "executor": {
               "configuration": {
                   "lambdaExecutorConfiguration": {
                       "lambdaFunctionArn": "arn:aws:lambda:us-west-2:<account-id>:function:my-function"
                   }
               },
               "type": "Lambda"
           },
           "id": {
               "category": "Test",
               "owner": "ThirdParty",
               "provider": "TestProvider",
               "version": "1"
           },
           "inputArtifactDetails": {
               "minimumCount": 0,
               "maximumCount": 1
           },
           "outputArtifactDetails": {
               "minimumCount": 0,
               "maximumCount": 1
           },
           "permissions": {
               "allowedAccounts": [
                   "<account-id>"
               ]
           },
           "properties": []
       }
   }

1. Utilisez la get-action-type commande pour obtenir la structure de votre type d'action. Copiez la structure.

2. Créez un fichier JSON d'entrée et nommez-leaction.json. Collez-y la structure du type d'action que vous avez copiée à l'étape précédente. Mettez à jour les paramètres que vous souhaitez modifier. Vous pouvez également ajouter des paramètres facultatifs.

   Pour plus d'informations sur les paramètres du fichier d'entrée, consultez la description du fichier de définition d'action dansÉtape 2 : Création d'un fichier de définition du type d'action.

   L'exemple suivant montre comment mettre à jour un exemple de type d'action créé avec le modèle d'intégration Lambda. Cet exemple apporte les modifications suivantes :

   • Change le provider nom enTestProvider1.

   • Ajoutez une limite de délai d'expiration des tâches de 900 secondes.

   • Ajoute une propriété de configuration d'action nommée Host qui est affichée au client à l'aide de l'action.

     {
         "actionType": {
             "executor": {
                 "configuration": {
                     "lambdaExecutorConfiguration": {
                         "lambdaFunctionArn": "arn:aws:lambda:us-west-2:<account-id>:function:my-function"
                     }
                 },
                 "type": "Lambda",
                 "jobTimeout": 900 
             },
             "id": {
                 "category": "Test",
                 "owner": "ThirdParty",
                 "provider": "TestProvider1",
                 "version": "1"
             },
             "inputArtifactDetails": {
                 "minimumCount": 0,
                 "maximumCount": 1
             },
             "outputArtifactDetails": {
                 "minimumCount": 0,
                 "maximumCount": 1
             },
             "permissions": {
                 "allowedAccounts": [
                     "account-id"
                 ]
             },
             "properties": {
              "description": "Owned build action parameter description",
              "optional": true,
              "noEcho": false,
              "key": true,
              "queryable": false,
              "name": "Host"
              }
         }
     }
     

3. Sur le terminal ou sur la ligne de commande, exécutez la update-action-type commande

   aws codepipeline update-action-type --cli-input-json file://action.json

   Cette commande renvoie la sortie du type d'action correspondant à vos paramètres mis à jour.