設定和使用 Gradle Groovy - Amazon CodeCatalyst

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

設定和使用 Gradle Groovy

若要將 Gradle Groovy 與 搭配使用 CodeCatalyst,您必須將 Gradle Groovy 連接至套件儲存庫,並提供用於身分驗證的個人存取權杖 (PAT)。您可以在 CodeCatalyst 主控台中檢視將 Gradle Groovy 連接至套件儲存庫的指示。

從 擷取相依性 CodeCatalyst

下列指示說明如何設定 Gradle Groovy 來擷取 CodeCatalyst 套件儲存庫的相依性。

使用 Gradle Groovy 從 CodeCatalyst 套件儲存庫擷取相依性
  1. 在 https://https://codecatalyst.aws/ 開啟 CodeCatalyst 主控台。

  2. 導覽至您的專案。

  3. 在導覽窗格中,選擇 Packages (套件)

  4. 從套件儲存庫清單中選擇套件儲存庫。

  5. 選擇連線至儲存庫

  6. 連線至儲存庫對話方塊中,從套件管理員用戶端清單中選擇 Gradle Groovy

  7. 您需要個人存取權杖 (PAT),才能使用 來驗證 Gradle Groovy CodeCatalyst。如果您已經有 ,則可以使用它。如果沒有,您可以在這裡建立。

    1. 選擇建立權杖

    2. 選擇複製以複製您的 PAT。

      警告

      關閉對話方塊後,您將無法PAT再次查看或複製您的 。

  8. 使用存取憑證更新您的梯度屬性檔案。Replace (取代) username 您的 CodeCatalyst 使用者名稱並取代 PAT 使用 CodeCatalyst 您的個人存取權杖。您可以使用 的任何值 spaceUsername 以及 spacePassword 只要您在下列步驟中使用相同的值。

    spaceUsername=username spacePassword=PAT
  9. 若要從 Gradle 建置 CodeCatalyst 中擷取相依性,請複製maven程式碼片段並將其新增至專案build.gradle檔案中的 repositories區段。取代下列值。您可以使用 的任何值 spaceName 只要您在下列步驟中使用相同的值。

    注意

    如果從主控台指示複製,則應為您更新下列值,且不應變更。

    • Replace (取代) space_name 您的 CodeCatalyst空間名稱。

    • Replace (取代) proj_name 您的 CodeCatalyst專案名稱。

    • Replace (取代) repo_name 使用套件 CodeCatalyst儲存庫名稱。

    maven { name = 'spaceName' url = uri('https://packages.region.codecatalyst.aws/maven/space_name/proj_name/repo_name/') credentials(PasswordCredentials) }
  10. (選用) 若要使用 CodeCatalyst 套件儲存庫做為專案相依性的唯一來源,請從 build.gradle 檔案中移除儲存庫中的任何其他區段。如果您有多個儲存庫,Gradle 會依列出的順序搜尋每個儲存庫的相依性。

從 擷取外掛程式 CodeCatalyst

預設情況下,Gradle 會從公有 Gradle 外掛程式入口網站 解析外掛程式。下列步驟會將 Gradle 專案設定為從 CodeCatalyst 套件儲存庫解析外掛程式。

使用 Gradle 從 CodeCatalyst 套件儲存庫擷取外掛程式
  1. 開啟 CodeCatalyst 主控台,網址為 https://https://codecatalyst.aws/

  2. 導覽至您的專案。

  3. 在導覽窗格中,選擇 Packages (套件)

  4. 從套件儲存庫清單中選擇套件儲存庫。

  5. 選擇連線至儲存庫

  6. 連線至儲存庫對話方塊中,從套件管理員用戶端清單中選擇 Gradle

  7. 您需要個人存取權杖 (PAT) 才能使用 來驗證 Gradle CodeCatalyst。如果您已經有 ,則可以使用它。如果沒有,您可以在這裡建立。

    1. 選擇建立權杖

    2. 選擇複製以複製您的 PAT。

      警告

      關閉對話方塊後,您將無法PAT再次查看或複製您的 。

  8. 使用存取憑證更新您的梯度屬性檔案。Replace (取代) username 您的 CodeCatalyst 使用者名稱並取代 PAT 使用 CodeCatalyst 您的個人存取權杖。您可以使用 的任何值 spaceUsername 以及 spacePassword 只要您在下列步驟中使用相同的值。

    spaceUsername=username spacePassword=PAT
  9. pluginManagement區塊新增至您的settings.gradle檔案。pluginManagement 區塊必須出現在 中任何其他陳述式之前settings.gradle。取代下列值。

    注意

    如果從主控台指示複製,則應為您更新下列值,且不應變更。

    • Replace (取代) spaceName 名稱值。

    • Replace (取代) space_name 您的 CodeCatalyst空間名稱。

    • Replace (取代) proj_name 您的 CodeCatalyst專案名稱。

    • Replace (取代) repo_name 使用套件 CodeCatalyst儲存庫名稱。

    pluginManagement { repositories { maven { name = 'spaceName' url = uri('https://packages.region.codecatalyst.aws/maven/space_name/proj_name/repo_name/') credentials(PasswordCredentials) } } }

    這將確保 Gradle 從指定的儲存庫解析外掛程式。儲存庫必須設定 Gradle 外掛程式入口網站 (gradle-plugins-store) 的上游連線,以便建置可以使用常見的 Gradle 外掛程式。如需詳細資訊,請參閱 Gradle 文件

透過 從外部套件儲存庫擷取套件 CodeCatalyst

您可以使用代表閘道儲存庫的閘道上游連線,透過儲存庫從公有 CodeCatalyst儲存庫安裝 Maven 套件。從閘道儲存庫安裝的套件會擷取並儲存在您的 CodeCatalyst儲存庫中。

CodeCatalyst 支援下列公有 Maven 套件儲存庫。

  • maven-central-gateway

  • google-android-gateway

  • gradle-plugins-gateway

  • commonsware-gateway

從公有 Maven 套件儲存庫安裝套件
  1. 如果您尚未設定 Gradle,請依照 從 擷取相依性 CodeCatalyst或 中的步驟,使用 CodeCatalyst 套件儲存庫設定 Gradle從 擷取外掛程式 CodeCatalyst

  2. 確保您的儲存庫已新增您要從中安裝的閘道儲存庫作為上游連線。您可以遵循 中的指示新增上游儲存庫,然後選擇要新增為上游的公有套件儲存庫,以執行此操作。

如需從上游儲存庫請求套件的詳細資訊,請參閱 使用上游儲存庫請求套件版本

將套件發佈至 CodeCatalyst

本節說明如何將以 Gradle Groovy 建置的 CodeCatalyst Java 程式庫發佈至儲存庫。

使用 Gradle Groovy 將套件發佈至 CodeCatalyst 套件儲存庫
  1. 在 https://https://codecatalyst.aws/ 開啟 CodeCatalyst 主控台。

  2. 在專案的概觀頁面上,選擇套件

  3. 從套件儲存庫清單中選擇套件儲存庫。

  4. 選擇連線至儲存庫

  5. 連線至儲存庫對話方塊中,從套件管理員用戶端清單中選擇 Gradle Groovy

  6. 您需要個人存取權杖 (PAT) 才能使用 來驗證 Gradle CodeCatalyst。如果您已經有 ,則可以使用它。如果沒有,您可以在這裡建立。

    1. 選擇建立權杖

    2. 選擇複製以複製您的 PAT。

      警告

      關閉對話方塊後,您將無法PAT再次查看或複製您的 。

  7. 使用存取憑證更新您的梯度屬性檔案。Replace (取代) username 您的 CodeCatalyst 使用者名稱並取代 PAT 使用 CodeCatalyst 您的個人存取權杖。您可以使用 的任何值 spaceUsername 以及 spacePassword 只要您在下列步驟中使用相同的值。

    spaceUsername=username spacePassword=PAT
  8. maven-publish外掛程式新增至專案build.gradle檔案的 plugins區段。

    plugins { id 'java-library' id 'maven-publish' }
  9. 接下來,將publishing區段新增至專案build.gradle檔案。取代下列值。

    注意

    如果從主控台指示複製,則應為您更新下列值,且不應變更。

    • Replace (取代) space_name 您的 CodeCatalyst空間名稱。

    • Replace (取代) proj_name 您的 CodeCatalyst專案名稱。

    • Replace (取代) repo_name 使用套件 CodeCatalyst儲存庫名稱。

    publishing { publications { mavenJava(MavenPublication) { groupId = 'group-id' artifactId = 'artifact-id' version = 'version' from components.java } } repositories { maven { name = 'spaceName' url = uri('https://packages.region.codecatalyst.aws/maven/space_name/proj_name/repo_name/') credentials(PasswordCredentials) } } }

    maven-publish 外掛程式會根據 publishing 區段中version指定的 groupIdartifactId和 產生POM檔案。

  10. 這些變更為 build.gradle 完成後,請執行下列命令來建置專案,並將其上傳至儲存庫。

    ./gradlew publish
  11. 在 CodeCatalyst 主控台中導覽至套件儲存庫,以檢查套件是否已成功發佈。您應該會在套件儲存庫的套件清單中看到套件。

如需詳細資訊,請參閱 Gradle 網站上的下列主題:

在 IntelliJ 中執行 Gradle 建置 IDEA

您可以在 IntelliJ 中執行 Gradle 建置IDEA,該建置會從 提取相依性 CodeCatalyst。若要使用 驗證 Gradle CodeCatalyst,您必須使用個人存取權杖 (PAT)。您可以將 CodeCatalyst PAT存放在 中,gradle.properties或您選擇的個別檔案。

方法 1:將 PAT放入 gradle.properties

如果您不使用 gradle.properties 檔案,並可以使用 覆寫其內容,請使用此方法PAT。如果您使用的是 gradle.properties,您可以修改此方法以新增 PAT,而不是覆寫檔案的內容。

注意

此範例顯示位於 中的gradle.properties檔案GRADLE_USER_HOME

首先,PAT如果您沒有 ,請建立 。

建立個人存取權杖 (PAT)
  1. 在頂端選單列中,選擇您的設定檔徽章,然後選擇我的設定

    提示

    您也可以前往專案或空間的成員頁面,並從成員清單中選擇您的姓名,以尋找您的使用者設定檔。

  2. PAT名稱 中,輸入 的描述性名稱PAT。

  3. 到期日 中,保留預設日期,或選擇行事曆圖示以選取自訂日期。過期日期預設為目前日期的一年。

  4. 選擇 Create (建立)。

    您也可以在為來源儲存庫選擇複製儲存庫時建立此權杖。

  5. 將PAT秘密儲存在安全的位置。

    重要

    PAT 秘密只會顯示一次。關閉視窗後就無法擷取它。

接下來,使用下列程式碼片段更新您的build.gradle檔案:

repositories { maven { name = 'spaceName' url = uri('https://packages.region.codecatalyst.aws/maven/space_name/proj_name/repo_name/') credentials(PasswordCredentials) } }

方法 2:將 PAT放入單獨的 檔案中

如果您不想修改gradle.properties檔案,請使用此方法。

首先,PAT如果您沒有 ,請建立 。

建立個人存取權杖 (PAT)
  1. 在頂端選單列中,選擇您的設定檔徽章,然後選擇我的設定

    提示

    您也可以前往專案或空間的成員頁面,並從成員清單中選擇您的姓名,以尋找您的使用者設定檔。

  2. PAT名稱 中,輸入 的描述性名稱PAT。

  3. 到期日 中,保留預設日期或選擇行事曆圖示以選取自訂日期。過期日期預設為目前日期的一年。

  4. 選擇 Create (建立)。

    您也可以在為來源儲存庫選擇複製儲存庫時建立此權杖。

  5. 將PAT秘密儲存在安全的位置。

    重要

    PAT 秘密只會顯示一次。關閉視窗後就無法擷取它。

將 PAT放入單獨的 檔案中
  1. 使用下列程式碼片段更新您的build.gradle檔案。Replace (取代) space_name, proj_namerepo_name 您的 CodeCatalyst 使用者名稱、空間名稱、專案名稱和套件儲存庫名稱。

    def props = new Properties() file("fileName").withInputStream { props.load(it) } repositories { maven { name = 'spaceName' url = uri('https://packages.region.codecatalyst.aws/maven/space_name/proj_name/repo_name/') credentials(PasswordCredentials) } } }
  2. PAT 將 寫入檔案中指定的build.gradle檔案:

    echo "codecatalystArtifactsToken=PAT" > fileName