開始使用自訂藍圖 - Amazon CodeCatalyst
必要條件步驟 1：在中建立自訂藍圖 CodeCatalyst步驟 2：使用元件開發自訂藍圖步驟 3：預覽自訂藍圖(選用) 步驟 4：發佈自訂藍圖預覽版本

本文為英文版的機器翻譯版本，如內容有任何歧義或不一致之處，概以英文版為準。

開始使用自訂藍圖

在建立藍圖的過程中，您可以設定藍圖並產生專案資源的預覽。每個自訂藍圖均由一個 CodeCatalyst 專案管理，該專案預設包含用於發佈至空間藍圖目錄的工作流程。

在設定自訂藍圖的詳細資料時，您也可以選擇將藍圖的原始程式碼儲存在第三方存放庫中，您仍然可以在其中管理自訂藍圖，並利用生命週期管理功能在修改自訂藍圖時保持空間的專案同步。如需詳細資訊，請參閱 為具有擴充功能的專案新增功能 CodeCatalyst 及 以藍圖作者身分使用生命週期管理。

如果您已經擁有具有標準化和最佳做法的來源存放庫，則可以選擇將該來源存放庫轉換為自訂藍圖。如需詳細資訊，請參閱 將來源儲存庫轉換為自訂藍圖。

必要條件

建立自訂藍圖之前，請考慮下列需求：

步驟 1：在中建立自訂藍圖 CodeCatalyst

當您從空間的設定建立自訂藍圖時，會為您建立存放庫。存放庫包含將藍圖發佈到空間的藍圖目錄之前，您必須擁有的所有必要資源，以開發藍圖。

建立自訂藍圖

  1. 開啟主 CodeCatalyst 控台，網址為 https://codecatalyst.aws/。

  2. 在主 CodeCatalyst 控台中，導覽至要建立自訂藍圖的空間。

  3. 在空間儀表板上，選擇 [設定] 索引標籤，然後選擇 [藍圖]。

  4. 選擇 [建立藍圖]。

  5. 在為您的藍圖命名下，輸入要指派給專案的名稱及其關聯的資源名稱。名稱在您的空間中必須是唯一的。

  6. (選擇性) 依預設，藍圖建立的原始程式碼會儲存在存放 CodeCatalyst 庫中。或者，您可以選擇將藍圖的原始程式碼儲存在第三方存放庫中。如需詳細資訊，請參閱 為具有擴充功能的專案新增功能 CodeCatalyst。

    根據您要使用的第三方儲存庫提供者，執行下列其中一項作業：

    • GitHub 存儲庫：Connect 一個 GitHub 帳戶。

      選擇 [進階] 下拉式功能表，選擇 GitHub做為存放庫提供者，然後選擇要儲存藍圖建立之原始程式碼的 GitHub 帳戶。

      注意

      如果您使用 GitHub 帳戶的連線，您必須建立個人連線，以便在您的身分與身分之間建立 CodeCatalyst 身 GitHub 分對應。如需詳細資訊，請參閱 個人連接 及 透過個人連線存取 GitHub 資源。

    • 比特桶存儲庫：Connect 比特桶工作區。

      選擇 [進階] 下拉式功能表，選擇 Bitbucket 做為儲存庫提供者，然後選擇您要儲存藍圖建立之原始程式碼的 Bitbucket 工作區。

    • GitLab 儲存庫：Connect 使 GitLab 用者。

      選擇 [進階] 下拉式功能表，選擇 GitLab做為存放庫提供 GitLab 者，然後選擇要儲存藍圖建立之原始程式碼的使用者。

  7. 在藍圖詳細資料下，執行下列操作：

    1. 在藍圖顯示名稱文字輸入欄位中，輸入將出現在空間藍圖目錄中的名稱。

    2. 在描述文字輸入欄位中，輸入自訂藍圖的描述。

    3. 在「作者名稱」文字輸入欄位中，輸入自訂藍圖的作者名稱。

    4. (選擇性) 選擇「進階」設定。

      1. 選擇 [+ 新增] 以新增新增至package.json檔案的標籤。

      2. 選擇 [授權] 下拉式功能表，然後為您的自訂藍圖選擇授權。

      3. 在藍圖套件名稱文字輸入欄位中，輸入用於識別藍圖套件的名稱。

      4. 依預設，會使用名為「藍圖產生器」的專案中的發佈藍圖產生發行工作流程。當您推送變更時，工作流程會將最新的藍圖版本發佈到您的空間，因為發行工作流程已啟用發佈權限。欲關閉工作流程產生，請取消核取「發行工作流程」核取方塊

  8. (選擇性) 藍圖專案隨附預先定義的程式碼，以支援將藍圖發佈到空間的藍圖目錄。若要根據您選取的專案參數檢視含有更新的定義檔，請從 [產生藍圖預覽] 中選擇 [檢視程式碼] 或 [檢視工作流程]。

  9. 選擇 [建立藍圖]。

如果您沒有關閉自訂藍圖的工作流程產生，則工作流程會在建立藍圖時自動開始執行。工作流程執行完成後，依預設，您的自訂藍圖即可新增至空間的藍圖目錄。如果您不希望將最新的藍圖版本自動發佈到您的空間，則可以關閉發佈權限。如需詳細資訊，請參閱 設定自訂藍圖的發佈權限 及 執行工作流程。

由於呼叫的發佈工作流程blueprint-release是使用藍圖建立的，因此可以在專案中找到該藍圖做為套用的藍圖。如需詳細資訊，請參閱 在專案中新增藍圖以整合資源 及 取消藍圖與專案的關聯以停止更新。

步驟 2：使用元件開發自訂藍圖

當您建立自訂藍圖時會產生藍圖精靈，並且可在開發自訂藍圖時使用元件對其進行修改。您可以更新src/blueprints.js和src/defaults.json檔案以修改精靈。

重要

如果您想要使用來自外部來源的藍圖套件，請考慮這些套件可能帶來的風險。您必須負責新增至空間的自訂藍圖及其產生的程式碼。

在設定藍圖程式碼之前，使用支援的整合式開發環境 (IDE) 在 CodeCatalyst 專案中建立開發環境。要使用必要的工具和套件，開發環境是必要的。

若要建立開發環境

  1. 在導覽窗格中，執行下列其中一項作業：

    1. 選擇 [概觀]，然後瀏覽至 [我的開發環境] 區段。

    2. 選擇 [程式碼]，然後選擇 [開發環境]。

    3. 選擇 [程式碼]，選擇 [來源存放庫]，然後選擇您在建立藍圖時建立的存放庫。

  2. 選擇 [建立開發環境]。

  3. 從下拉式功能表中選擇支援的 IDE。如需詳細資訊，請參閱開發環境支援的整合式開發環境。

  4. 選擇「在現有分支中工作」，然後從「現有分支」下拉式功能表中選擇您建立的功能分支。

  5. (選擇性) 在別名-選擇性文字輸入欄位中，輸入別名以識別開發環境。

  6. 選擇建立。建立您的開發環境時，開發環境狀態欄會顯示 [啟動]，且狀態欄會在建立開發環境時顯示 [執行中]。

如需詳細資訊，請參閱 使用開發環境編寫和修改代碼 CodeCatalyst。

開發您的自訂藍圖

  1. 在工作終端中，使用以下yarn命令來安裝依賴關係：

    yarn

    所需的工具和套件可透過 CodeCatalyst 開發環境取得，包括 Yarn。如果您正在使用沒有開發環境的自訂藍圖，請先將 Yarn 安裝到您的系統。如需詳細資訊，請參閱 Yarn 的安裝文件。

  2. 開發您的自訂藍圖，以便根據您的喜好進行設定。您可以透過新增元件來修改藍圖的精靈。如需詳細資訊，請參閱開發自訂藍圖以符合專案需求、使用前端精靈修改藍圖功能及將自訂藍圖發佈到空間。

步驟 3：預覽自訂藍圖

設定和開發自訂藍圖後，您可以預覽藍圖的預覽版本，並將其發佈到您的空間。預覽版本可讓您在藍圖用於建立新專案或套用至現有專案之前，先檢查藍圖是否是您想要的。

預覽自訂藍圖

  1. 在工作終端中，使用以下yarn命令：

    yarn blueprint:preview

  2. 導覽至提供的See this blueprint at:連結以預覽您的自訂藍圖。

  3. 根據您的組態，檢查 UI (包括文字) 是否如預期般顯示。如果您想要變更自訂藍圖，可以編輯blueprint.ts檔案、重新同步藍圖，然後再次發佈預覽版本。如需詳細資訊，請參閱 樹脂同步。

(選用) 步驟 4：發佈自訂藍圖預覽版本

如果要將自訂藍圖新增至空間的藍圖目錄，您可以將自訂藍圖的預覽版本發佈到您的空間。這可讓您在將非預覽版本新增至目錄之前，以使用者身分檢視藍圖。預覽版可讓您在不佔用實際版本的情況下發佈。例如，如果您使用某個0.0.1版本，則可以發佈並新增預覽版本，以便可以將第二個版本的新更新發行並新增為0.0.2。

發佈自訂藍圖的預覽版本

導覽至提供的Enable version [version number] at:連結以啟用您的自訂藍圖。在中執行yarn指令時會提供此連結步驟 3：預覽自訂藍圖。

在建立、開發、預覽和發佈自訂藍圖之後，您可以將最終藍圖版本發佈並新增至空間的藍圖目錄。如需更多詳細資訊，請參閱 將自訂藍圖發佈到空間 及 將自訂藍圖新增至空間藍圖目錄。