本文為英文版的機器翻譯版本,如內容有任何歧義或不一致之處,概以英文版為準。
在建立藍圖的過程中,您可以設定藍圖並產生專案資源的預覽。每個自訂藍圖都由 CodeCatalyst 專案管理,該專案預設包含發佈至空間藍圖目錄的工作流程。
設定自訂藍圖的詳細資訊時,您也可以選擇將藍圖的原始碼存放在第三方儲存庫中,在其中,您仍然可以管理自訂藍圖,並使用生命週期管理功能,在修改自訂藍圖時保持空間的專案同步。如需詳細資訊,請參閱 在 CodeCatalyst 中將功能新增至具有擴充功能的專案 和 以藍圖作者身分使用生命週期管理。
如果您已經有具有標準化和最佳實務的來源儲存庫,您可以選擇將該來源儲存庫轉換為自訂藍圖。如需詳細資訊,請參閱將來源儲存庫轉換為自訂藍圖。
先決條件
在建立自訂藍圖之前,請考慮下列需求:
您的 CodeCatalyst 空間必須是 Enterprise 層。如需詳細資訊,請參閱《Amazon CodeCatalyst 管理員指南》中的管理帳單。
您需要有 Space 管理員或 Power 使用者角色,才能建立自訂藍圖。如需詳細資訊,請參閱使用使用者角色授予存取權。
步驟 1:在 CodeCatalyst 中建立自訂藍圖
當您從空間的設定建立自訂藍圖時,會為您建立儲存庫。儲存庫包含您在發佈至空間的藍圖目錄之前,必須開發藍圖的所有必要資源。
建立自訂藍圖
在 https://https://codecatalyst.aws/
開啟 CodeCatalyst 主控台。 在 CodeCatalyst 主控台中,導覽至您要建立自訂藍圖的空間。
在空間儀表板上,選擇設定索引標籤,然後選擇藍圖。
選擇建立藍圖。
在為您的藍圖命名下,輸入您要指派給專案的名稱及其相關聯的資源名稱。名稱在您的空間中必須是唯一的。
-
(選用) 根據預設,藍圖建立的原始碼會存放在 CodeCatalyst 儲存庫中。或者,您可以選擇將藍圖的原始程式碼存放在第三方儲存庫中。如需詳細資訊,請參閱在 CodeCatalyst 中將功能新增至具有擴充功能的專案。
根據您要使用的第三方儲存庫提供者,執行下列其中一項操作:
-
GitHub 儲存庫:連接 GitHub 帳戶。
選擇進階下拉式功能表,選擇 GitHub 做為儲存庫提供者,然後選擇您要存放藍圖所建立原始碼的 GitHub 帳戶。
注意
如果您使用 GitHub 帳戶的連線,則必須建立個人連線,以在 CodeCatalyst 身分和 GitHub 身分之間建立身分映射。如需詳細資訊,請參閱 個人連線 和 使用個人連線存取 GitHub 資源。
-
Bitbucket 儲存庫:連接 Bitbucket 工作區。
選擇進階下拉式功能表,選擇 Bitbucket 做為儲存庫提供者,然後選擇您要存放藍圖所建立原始碼的 Bitbucket 工作區。
-
GitLab 儲存庫:連接 GitLab 使用者。
選擇進階下拉式功能表,選擇 GitLab 做為儲存庫提供者,然後選擇您要存放藍圖所建立原始碼的 GitLab 使用者。
-
-
在藍圖詳細資訊下,執行下列動作:
在藍圖顯示名稱文字輸入欄位中,輸入將出現在空間藍圖目錄中的名稱。
在描述文字輸入欄位中,輸入自訂藍圖的描述。
在作者名稱文字輸入欄位中,輸入自訂藍圖的作者名稱。
-
(選用) 選擇進階設定。
選擇 + 新增以新增新增至
package.json
檔案的標籤。選擇授權下拉式功能表,然後選擇自訂藍圖的授權。
在藍圖套件名稱文字輸入欄位中,輸入名稱以識別您的藍圖套件。
在預設情況下,發行工作流程是使用稱為藍圖建置器的專案中的發佈藍圖產生。當您推送變更時,工作流程會將最新的藍圖版本發佈到您的空間,因為發佈工作流程已啟用發佈許可。若要關閉工作流程產生,請取消勾選釋出工作流程核取方塊。
(選用) 藍圖專案隨附預先定義的程式碼,以支援將藍圖發佈至空間的藍圖目錄。若要根據您所做的專案參數選擇來檢視具有更新的定義檔案,請選擇檢視程式碼或從產生藍圖預覽中檢視工作流程。
選擇建立藍圖。
如果您未關閉自訂藍圖的工作流程產生,工作流程會在建立藍圖時自動開始執行。當工作流程執行完成時,您的自訂藍圖預設可新增至空間的藍圖目錄。如果您不希望最新的藍圖版本自動發佈到您的空間,您可以關閉發佈許可。如需詳細資訊,請參閱 設定自訂藍圖的發佈許可 和 執行工作流程。
由於名為 的發佈工作流程blueprint-release
是使用藍圖建立的,因此可以在您的專案中找到藍圖做為套用的藍圖。如需詳細資訊,請參閱 在專案中新增藍圖以整合資源 和 取消藍圖與專案的關聯以停止更新。
步驟 2:使用元件開發自訂藍圖
當您建立自訂藍圖時,就會產生藍圖精靈,而且可以在開發自訂藍圖時,使用 元件進行修改。您可以更新 src/blueprints.js
和 src/defaults.json
檔案來修改精靈。
重要
如果您想要使用外部來源的藍圖套件,請考慮這些套件可能帶來的風險。您需為您新增至空間的自訂藍圖及其產生的程式碼負責。
在 CodeCatalyst 專案中使用支援的整合開發環境 (IDE) 建立開發環境,然後再設定藍圖程式碼。開發環境是使用所需工具和套件的必要項目。
建立開發環境
-
在導覽窗格中,執行下列其中一項操作:
選擇概觀,然後導覽至我的開發環境區段。
選擇程式碼,然後選擇開發環境。
選擇程式碼,選擇來源儲存庫,然後選擇您在建立藍圖時建立的儲存庫。
選擇建立開發環境。
從下拉式選單中選擇支援的 IDE。如需詳細資訊,請參閱開發環境支援的整合式開發環境。
選擇在現有分支中工作,然後從現有分支下拉式功能表中選擇您建立的功能分支。
(選用) 在別名 - 選用文字輸入欄位中,輸入別名以識別開發環境。
選擇 Create (建立)。建立開發環境時,開發環境狀態欄會顯示「開始」,而狀態欄會在建立開發環境時顯示「執行中」。
如需詳細資訊,請參閱在 CodeCatalyst 中使用開發環境撰寫和修改程式碼。
開發您的自訂藍圖
-
在運作中的終端機中,使用下列
yarn
命令來安裝相依性:yarn
必要的工具和套件可透過 CodeCatalyst 開發環境取得,包括 Yarn。如果您使用的是沒有開發環境的自訂藍圖,請先將 Yarn 安裝到您的系統。如需詳細資訊,請參閱 Yarn 的安裝文件
。 -
開發您的自訂藍圖,使其設定為您的偏好設定。您可以新增元件來修改藍圖的精靈。如需詳細資訊,請參閱開發符合專案需求的自訂藍圖、使用前端精靈修改藍圖功能及將自訂藍圖發佈至空間。
步驟 3:預覽自訂藍圖
在設定和開發自訂藍圖之後,您可以預覽藍圖的預覽版本並將其發佈至您的空間。預覽版本可讓您在建立新專案或套用至現有專案之前,先檢查藍圖是否為您想要的。
預覽自訂藍圖
-
在運作中的終端機中,使用下列
yarn
命令:yarn blueprint:preview
-
導覽至提供
See this blueprint at:
的連結以預覽您的自訂藍圖。 檢查包含文字的 UI 是否根據您的組態如預期顯示。如果您想要變更自訂藍圖,您可以編輯
blueprint.ts
檔案、重新合成藍圖,然後再次發佈預覽版本。如需詳細資訊,請參閱重新合成。
(選用) 步驟 4:發佈自訂藍圖預覽版本
如果您想要將自訂藍圖的預覽版本新增至空間的藍圖目錄,您可以將其發佈至您的空間。這可讓您以使用者身分檢視藍圖,然後再將非預覽版本新增至目錄。預覽版本可讓您發佈 ,而不需佔用實際版本。例如,如果您使用 0.0.1
版本,您可以發佈並新增預覽版本,因此第二個版本的新更新可以發佈並新增為 0.0.2
。
發佈自訂藍圖的預覽版本
導覽至提供Enable version
的連結以啟用您的自訂藍圖。在 中執行 [version number]
at:yarn
命令時,會提供此連結步驟 3:預覽自訂藍圖。
在建立、開發、預覽和發佈自訂藍圖之後,您可以將最終藍圖版本發佈並新增至空間的藍圖目錄。如需詳細資訊,請參閱 將自訂藍圖發佈至空間 和 將自訂藍圖新增至空間藍圖目錄。