使用操作类型

注册 Lambda 集成请求

• 使用以下表格向 CodePipeline 服务团队发送请求。

  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 Amazon Web Services 区域 where your action will be available
  
  5. Will this be available as a public action?
  

注册作业辅助角色集成请求

• 使用以下表格向 CodePipeline 服务团队发送请求。

  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 Amazon Web Services 区域 where your action will be available
  
  5. Will this be available as a public action?

从 CodePipeline 控制台向现有管道添加操作类型

1. 登录 Amazon Web Services Management Console 并打开 CodePipeline 控制台，网址为 http://console.aws.amazon.com/codesuite/codepipeline/home。

2. 在管道列表中，选择要在其中添加操作类型的管道。

3. 在管道的摘要视图页面中，选择编辑。

4. 选择编辑阶段。在要向其添加操作类型的阶段中，选择添加操作组。此时将显示编辑操作页面。

5. 在编辑操作页面的操作名称下，输入操作的名称。这是为管道中的阶段显示的名称。

6. 在操作提供程序中，从列表中选择您的操作类型。

   请注意，列表中的值基于操作类型定义文件中指定的 provider。

7. 在输入构件中，按照以下格式输入构件名称：

   Artifactname::FileName

   请注意，所允许的最小和最大数量基于操作类型定义文件中指定的 inputArtifactDetails。

8. 选择连接到 <Action_Name>。

   此时将打开一个浏览器窗口，并连接到您为操作类型创建的网站。

9. 以客户身份登录您的网站，完成客户为使用您的操作类型而应采取的步骤。您的步骤将会根据操作类别、网站和配置而有所不同，但通常会包含一个完成操作，使客户返回编辑操作页面。

10. 在 CodePipeline “编辑” 操作页面中，将显示该操作的其他配置字段。所显示的字段是您在操作定义文件中指定的配置属性。在为您的操作类型自定义的字段中输入信息。

    例如，如果操作定义文件指定了一个名为 Host 的属性，则操作的编辑操作页面上会显示一个带有主机标签的字段。

11. 在输出构件中，按照以下格式输入构件名称：

    Artifactname::FileName

    请注意，所允许的最小和最大数量基于操作类型定义文件中指定的 outputArtifactDetails。

12. 选择完成以返回管道详细信息页面。

    注意

    您的客户可以选择使用 CLI 将操作类型添加到他们的管道中。

13. 要测试您的操作，请向管道源阶段中指定的源提交更改，或者按照手动启动管道中的步骤进行操作。

查看操作类型

1. 创建一个输入 JSON 文件并将该文件命名为 file.json。以 JSON 格式添加您的操作类型 ID，如以下示例所示。

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

2. 在终端窗口或命令行中，运行 get-action-type 命令。

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

   此命令会返回操作类型的操作定义输出。此示例显示了一个使用 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. 使用 get-action-type 命令获取您的操作类型的结构。复制该结构。

2. 创建一个输入 JSON 文件并将其命名为 action.json。将您在上一步中复制的操作类型结构粘贴到其中。更改您要更新的任何参数。您也可以添加可选的参数。

   有关输入文件参数的更多信息，请参阅步骤 2：创建操作类型定义文件中的操作定义文件。

   下面的示例展示了如何更新使用 Lambda 集成模型创建的操作类型。此示例中将做出以下更改：

   • 将 provider 名称更改为 TestProvider1。

   • 添加 900 秒的作业超时限制。

   • 添加名为 Host 的操作配置属性，该属性将向使用该操作客户显示。

     {
         "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. 在终端或命令行中，运行 update-action-type 命令。

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

   此命令会返回与更新后的参数相匹配的操作类型输出。