Bekerja dengan tipe tindakan

Untuk mendaftarkan permintaan integrasi Lambda

• Kirim permintaan ke tim CodePipeline layanan menggunakan formulir berikut.

  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 Wilayah AWS where your action will be available
  
  5. Will this be available as a public action?
  

Untuk mendaftarkan permintaan integrasi pekerja kerja

• Kirim permintaan ke tim CodePipeline layanan menggunakan formulir berikut.

  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 Wilayah AWS where your action will be available
  
  5. Will this be available as a public action?

Untuk menambahkan tipe tindakan ke pipeline yang ada dari CodePipeline konsol

1. Masuk ke AWS Management Console dan buka CodePipeline konsol di http://console.aws.amazon.com/codesuite/codepipeline/home.

2. Dalam daftar pipeline, pilih pipeline tempat Anda ingin menambahkan tipe tindakan.

3. Pada halaman tampilan ringkasan pipeline, pilih Edit.

4. Pilih untuk mengedit panggung. Pada tahap di mana Anda ingin menambahkan tipe tindakan Anda, pilih Tambahkan grup tindakan. Halaman Edit tindakan ditampilkan.

5. Pada halaman Edit tindakan, dalam nama Tindakan, masukkan nama untuk tindakan tersebut. Ini adalah nama yang ditampilkan untuk panggung di pipeline Anda.

6. Di Penyedia tindakan, pilih jenis tindakan Anda dari daftar.

   Perhatikan bahwa nilai dalam daftar didasarkan pada yang provider ditentukan dalam file definisi tipe tindakan.

7. Di artefak Input, masukkan nama artefak dalam format ini:

   Artifactname::FileName

   Perhatikan bahwa jumlah minimum dan maksimum yang diizinkan ditentukan berdasarkan yang inputArtifactDetails ditentukan dalam file definisi tipe tindakan.

8. Pilih Connect to<Action_Name>.

   Jendela browser terbuka dan terhubung ke situs web yang telah Anda buat untuk jenis tindakan Anda.

9. Masuk ke situs web Anda sebagai pelanggan dan selesaikan langkah-langkah yang diambil pelanggan untuk menggunakan jenis tindakan Anda. Langkah-langkah Anda akan bervariasi tergantung pada kategori tindakan, situs web, dan konfigurasi Anda, tetapi biasanya mencakup tindakan penyelesaian yang mengembalikan pelanggan ke halaman tindakan Edit.

10. Di halaman CodePipeline Edit tindakan, bidang konfigurasi tambahan untuk tampilan tindakan. Bidang yang ditampilkan adalah properti konfigurasi yang Anda tentukan dalam file definisi tindakan. Masukkan informasi di bidang yang disesuaikan untuk jenis tindakan Anda.

    Misalnya, jika file definisi tindakan menetapkan properti bernamaHost, maka bidang dengan label Host ditampilkan di halaman Edit tindakan untuk tindakan Anda.

11. Dalam artefak Output, masukkan nama artefak dalam format ini:

    Artifactname::FileName

    Perhatikan bahwa jumlah minimum dan maksimum yang diizinkan ditentukan berdasarkan yang outputArtifactDetails ditentukan dalam file definisi tipe tindakan.

12. Pilih Selesai untuk kembali ke halaman detail pipeline.

    catatan

    Pelanggan Anda secara opsional dapat menggunakan CLI untuk menambahkan tipe tindakan ke pipeline mereka.

13. Untuk menguji tindakan Anda, lakukan perubahan ke sumber yang ditentukan dalam tahap sumber pipeline atau ikuti langkah-langkah dalam Memulai Pipeline secara Manual.

Untuk melihat tipe tindakan

1. Buat file JSON input dan beri nama filefile.json. Tambahkan ID tipe tindakan Anda dalam format JSON seperti yang ditunjukkan pada contoh berikut.

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

2. Di jendela terminal atau di baris perintah, jalankan get-action-type perintah.

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

   Perintah ini mengembalikan output definisi tindakan untuk tipe tindakan. Contoh ini menunjukkan tipe tindakan yang dibuat dengan model integrasi 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. Gunakan get-action-type perintah untuk mendapatkan struktur untuk tipe tindakan Anda. Salin strukturnya.

2. Buat file JSON input dan beri nama. action.json Tempelkan struktur tipe tindakan yang Anda salin pada langkah sebelumnya ke dalamnya. Perbarui parameter apa pun yang ingin Anda ubah. Anda juga dapat menambahkan parameter opsional.

   Untuk informasi selengkapnya tentang parameter untuk file input, lihat deskripsi file definisi tindakan diLangkah 2: Buat file definisi tipe tindakan.

   Contoh berikut menunjukkan cara memperbarui contoh jenis tindakan yang dibuat dengan model integrasi Lambda. Contoh ini membuat perubahan berikut:

   • Mengubah provider nama menjadiTestProvider1.

   • Tambahkan batas waktu kerja 900 detik.

   • Menambahkan properti konfigurasi tindakan bernama Host yang ditampilkan ke pelanggan menggunakan tindakan.

     {
         "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. Di terminal atau baris perintah, jalankan update-action-type perintah

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

   Perintah ini mengembalikan output tipe tindakan agar sesuai dengan parameter yang diperbarui.