配置和使用 Gradle Groovy - Amazon CodeCatalyst

本文属于机器翻译版本。若本译文内容与英语原文存在差异,则一律以英文原文为准。

配置和使用 Gradle Groovy

要将 Gradle Groovy 与配合使用 CodeCatalyst,您必须将 Gradle Groovy 连接到您的软件包存储库,并提供用于身份验证的个人访问令牌 ()。PAT你可以在控制台中查看将 Gradle Groovy 连接到软件包存储库的说明。 CodeCatalyst

从中获取依赖关系 CodeCatalyst

以下说明说明了如何配置 Gradle Groovy 以获取软件包存储 CodeCatalyst 库的依赖项。

使用 Gradle Groovy 从软件包存储库中获取依赖项 CodeCatalyst
  1. 打开 CodeCatalyst 控制台,网址为 https://codecatalyst.aws/

  2. 导航到您的项目。

  3. 在导航窗格中,选择 Packages (程序包)

  4. 从软件包存储库列表中选择您的软件包存储库。

  5. 选择 “连接到存储库”。

  6. 在 “连接到存储库” 对话框中,从包管理器客户端列表中选择 Gradle Groovy

  7. 你需要一个个人访问令牌 (PAT) 来对 Gradle Groovy 进行身份验证。 CodeCatalyst如果你已经有一个,你可以使用它。如果没有,你可以在这里创建一个。

    1. 选择创建令牌

    2. 选择 “复制” 以复制您的PAT.

      警告

      关闭对话框后,您将无法PAT再次查看或复制您的。

  8. 使用您的访问凭证更新您的 gradle 属性文件。Replace(替换) username 用你的 CodeCatalyst 用户名替换 PAT 使用您的 CodeCatalyst 个人访问令牌。你可以将任何值用于 spaceUsername 以及 spacePassword 只要您在以下步骤中使用相同的值。

    spaceUsername=username spacePassword=PAT
  9. 要从 Gradle 版本 CodeCatalyst 中获取依赖关系,请复制maven代码片段并将其添加到项目文件的相应repositories部分。build.gradle替换以下值。你可以将任何值用于 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://codecatalyst.aws/

  2. 导航到您的项目。

  3. 在导航窗格中,选择 Packages (程序包)

  4. 从软件包存储库列表中选择您的软件包存储库。

  5. 选择 “连接到存储库”。

  6. 在 “Connect to 存储库” 对话框中,从包管理器客户端列表中选择 Gradle

  7. 您需要使用个人访问令牌 (PAT) 来对 Gradle 进行 CodeCatalyst身份验证。如果你已经有一个,你可以使用它。如果没有,你可以在这里创建一个。

    1. 选择创建令牌

    2. 选择 “复制” 以复制您的PAT.

      警告

      关闭对话框后,您将无法PAT再次查看或复制您的。

  8. 使用您的访问凭证更新您的 gradle 属性文件。Replace(替换) username 用你的 CodeCatalyst 用户名替换 PAT 使用您的 CodeCatalyst 个人访问令牌。你可以将任何值用于 spaceUsername 以及 spacePassword 只要您在以下步骤中使用相同的值。

    spaceUsername=username spacePassword=PAT
  9. settings.gradle 文件中添加一个 pluginManagement 块。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

您可以通过存储库从公共存储库安装 Maven 软件包,方法是将其配置为与代表网关存储库的网关的上游连接。 CodeCatalyst从网关存储库安装的软件包会被提取并存储在您的存储 CodeCatalyst库中。

CodeCatalyst 支持以下公共 Maven 软件包存储库。

  • maven-central-gateway

  • google-android-gateway

  • gradle-plugins-gateway

  • 常用软件网关

从公共 Maven 软件包存储库安装软件包
  1. 如果您还没有,请按照从中获取依赖关系 CodeCatalyst从中获取插件 CodeCatalyst中的步骤使用您的 CodeCatalyst 软件包存储库配置 Gradle。

  2. 确保您的存储库已将您要从中安装的网关存储库添加为上游连接。为此,您可以按照中的说明进行操作,添加上游存储库然后选择要作为上游添加的公共软件包存储库。

有关从上游存储库请求软件包的更多信息,请参阅请求包含上游存储库的程序包版本

将包发布到 CodeCatalyst

本节介绍如何将使用 Gradle Groovy 构建的 Java 库发布到存储库。 CodeCatalyst

使用 Gradle Groovy 将软件包发布到软件包存储库 CodeCatalyst
  1. 打开 CodeCatalyst 控制台,网址为 https://codecatalyst.aws/

  2. 在项目的概述页面上,选择

  3. 从软件包存储库列表中选择您的软件包存储库。

  4. 选择 “连接到存储库”。

  5. 在 “连接到存储库” 对话框中,从包管理器客户端列表中选择 Gradle Groovy

  6. 您需要使用个人访问令牌 (PAT) 来对 Gradle 进行 CodeCatalyst身份验证。如果你已经有一个,你可以使用它。如果没有,你可以在这里创建一个。

    1. 选择创建令牌

    2. 选择 “复制” 以复制您的PAT.

      警告

      关闭对话框后,您将无法PAT再次查看或复制您的。

  7. 使用您的访问凭证更新您的 gradle 属性文件。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. 接下来,在项目 build.gradle 文件中添加一个 publishing 部分。替换以下值。

    注意

    如果从控制台说明中复制,则应为您更新以下值,且不应更改。

    • 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

你可以在 IDEA IntelliJ 中运行一个 Gradle 构建,从中提取依赖关系。 CodeCatalyst要对 Gradle 进行身份验证 CodeCatalyst,必须使用个人访问令牌 (PAT)。您可以将自己的文件存储 CodeCatalyst PAT在中gradle.properties或您选择的单独文件。

方法 1:放PAT入 gradle.properties

如果您不使用该gradle.properties文件并且可以用您的PAT文件覆盖其内容,请使用此方法。如果您正在使用gradle.properties,则可以修改此方法以添加PAT而不是覆盖文件内容。

注意

该示例显示了位于 GRADLE_USER_HOME 中的 gradle.properties 文件。

首先,PAT如果没有,请创建一个。

创建个人访问令牌 (PAT)
  1. 在顶部菜单栏中,选择您的个人资料徽章,然后选择我的设置

    提示

    您还可以前往项目或空间的成员页面,然后从成员列表中选择您的姓名,从而找到您的用户个人资料。

  2. PAT名称中,输入您的PAT描述性名称。

  3. 到期日期中,保留默认日期或选择日历图标以选择自定义日期。到期日期默认为自当前日期起一年。

  4. 选择创建

    当为源存储库选择克隆存储库时,也可以创建此令牌。

  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. 选择创建

    当为源存储库选择克隆存储库时,也可以创建此令牌。

  5. 将PAT密钥保存在安全的地方。

    重要

    该PAT密钥仅显示一次。关闭窗口后无法检索它。

把你PAT放在一个单独的文件里
  1. 使用以下片段更新您的build.gradle文件。Replace(替换) space_name, proj_name,以及 repo_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