关于配置 CI/CD 管道

首先,可以使 API 准备就绪。您应至少定义其端点并下载 OMC 为您生成的基架。Scaffold 表示您可以用来确保在提前和写入和测试您的定制 API 的代码之前,您的 CI/CD 进程正常工作。

当您的 API 准备就绪并且您可以在 Developer Cloud Service 项目中成功将更改推送到 Git 资源库时,为项目设置 CI/CD 的时间。

在 Oracle Mobile Hub 中设置 API

通过定义应用程序连接到的 REST 端点来创建 API 基架。完成基架后,可以下载其定义以用作 API 代码的起点。

为端点定义 HTTP 方法时,可以选择添加示例响应。严格说来,不需要示例响应,因为以后您将编写提供实际响应的代码。但是,您可能需要在定制代码就绪之前输入一些用于测试 API 的示例响应。

  1. 登录到 Oracle Mobile Hub 并打开导航面板。
  2. 在导航面板的应用程序部分中,单击 Api
  3. 单击新建 API,然后在打开的菜单中单击 API。
    此时将打开“新建 API ”窗口。
  4. API 显示名称字段和 API 名称字段中,为您的 API 输入合适的名称。
  5. 简要说明字段中,输入适当的说明。
  6. 如果您的 API 具有 RAML 文档,请在此处上载。
  7. 单击创建,此时将打开新 API 的页。
  8. 添加 HTTP 资源。如果您上载了 RAML 文档,则可以跳过此步骤。
    1. 单击端点,然后单击新建资源以创建第一个端点并定义其 HTTP 方法。
    2. 继续为您的 API 定义端点和 HTTP 方法,直至定义了所有端点。
  9. 单击保存

设置后端

创建 API 将使用的后端。后端将请求从应用程序路由到 API,并提供验证服务。

  1. Oracle Mobile Hub 导航面板中,单击后端,即可打开后端页。
  2. 单击新建后端,然后在窗口中打开在名称字段中输入合适的名称,然后单击创建
    此时将打开“后端配置”页。它有自己的导航面板,该面板在“设置 ”页上打开。
  3. 在配置页的导航面板中,单击 API,然后在打开的页面中单击选择 API(用于打开 API 目录)。
  4. 在目录中,找到所创建 API 的卡,然后单击其+ 按钮。这会将该 API 与该后端关联。

记录后端和实例详细信息

配置开发工具时需要的记录信息。

该信息在名为 toolsConfig.json 的文件中使用,需要进行验证。它使脚本可以连接到 Oracle Mobile Hub 并向其传送代码 Artifact。

  1. Oracle Mobile Hub 导航面板中,单击后端,即可打开后端页。
  2. 选择后端并单击打开
  3. 在导航面板中,单击设置
  4. 记录以下信息并将其复制到文本文件或其他位置,您可以在以后方便地检索该文件:
    • 客户机 ID
    • 客户端密钥
    • 后端 ID
    • 后端名称
    • 后端版本
    • 匿名密钥
  5. 在导航面板中,单击开以打开主页,然后单击实例详细信息以打开“实例详细信息 ”面板。
  6. 记录以下信息并保留您在上一步中记录的后端信息:
    • 团队成员应用程序客户端 ID
    • 团队成员应用程序客户端密钥

在 Oracle Developer Cloud Service 中设置项目

创建包含 Git 资料档案库的项目。以后,只要将提交推入资源库,就将项目配置为运行构建。

创建项目

创建包含 Git 资料档案库的项目。

  1. 登录到 Oracle Developer Cloud Service 控制台,然后单击新建项目
  2. 项目详细信息页上,输入项目的名称,然后单击下一步
  3. 模板页上,选择初始资料档案库,然后单击下一步
  4. 在“项目属性 ”页上,接受默认值并单击完成以开始预配过程。

预配项目后,您的屏幕应与下面的图像类似:


项目汇总页

克隆和配置 Git 资料档案库

将资料档案库克隆到本地开发系统。

  1. 登录 Oracle Developer Cloud Service 并导航到项目页。
  2. 从字段复制 Git 资料档案库的 HTTP 地址。
  3. 打开一个终端窗口(在 Linux 或 Mac 上)或 Git Bash 终端(在 Windows 上),然后在硬盘驱动器上的适当位置创建一个新目录。请使用适合您项目的目录的名称。
     mkdir <your-directory-name>
  4. 更改为目录并克隆资料档案库,使用您自己的资料档案库地址替换示例中的资料档案库地址。
    cd <your-directory-name>
    git clone <your-repo-url>

    提示输入口令时,请使用用于登录 Oracle Developer Cloud Service 的口令。

  5. 更改为克隆进程创建的目录。
    cd <your-directory-name>
  6. 为此项目设置名称和电子邮件地址 , 并配置 Git 以存储身份证明。
    git config user.name "<your-name>"
    git config user.email "<your-email-address>"
    git config credential.helper store

创建新构建作业

创建将在将代码推送到项目 Git 资料档案库时运行的作业。

  1. 登录 Oracle Developer Cloud Service 并导航到项目页。
  2. 在导航面板中,单击构建,然后在打开的页中单击新建作业
  3. 输入名称并选择软件模板,然后单击创建作业
  4. 单击添加源控件并选择 Git
  5. 资料档案库下拉列表中,选择要使用的 Git 资料档案库。
  6. 可选:如果您是将代码推送到资源库的唯一开发人员,请选择在 SCM 提交时自动执行构建

    如果有多个人在处理项目并将代码推送到存储库,则不要选择此选项。可以设置 SCM 轮询触发器,而是在完成创建构建作业后执行此操作。

  7. 单击保存

配置 SCM 轮询触发器

可以在定义的调度上设置一个检查对 Git 资料档案库的更改的轮询。如果检测到更改,将启动构建。

如果您是将代码推送到资料档案库的唯一开发人员,则立即构建可能适用。不过,当多个人员将推送代码时,可以设置一个轮询触发器,以定期在启动构建之前检查对资料档案库的更改。

要设置 SCM 轮询触发器,请使用 crontab 格式设置轮询调度。如果您不熟悉 crontab 格式,可以使用图形界面创建调度。

默认调度是每 30 分钟一次,由0/30 * * * *表示。要将调度设置为在过去 30 分钟的每小时内运行,请使用30 * * * *

  1. 登录到 Oracle Developer Cloud Service 控制台,然后打开项目。
  2. 在导航面板中,单击建,然后选择要为其设置参数的构建。
    此时将打开“构建设置 ”页。
  3. 单击配置。
    此时将打开“作业配置 ”页。
  4. 单击齿轮图标设置图标看起来像一对齿轮。,然后单击触发器以打开“配置构建触发器 ”面板。
  5. 单击添加触发器下拉列表,然后选择 SCM 轮询触发器
  6. 设置调度并单击保存

设置构建参数

设置字符串参数和口令参数以保存 Oracle Mobile Hub 帐户的用户名和口令。

请记录这些参数的名称,因为以后在配置开发人员工具时需要它们。

  1. 登录到 Oracle Developer Cloud Service 控制台,然后打开项目。
  2. 在导航面板中,单击建,然后选择要为其设置参数的构建。
    此时将打开“构建设置 ”页。
  3. 单击配置
    此时将打开“作业配置 ”页。
  4. 单击构建参数选项卡。
  5. 单击添加构建参数下拉列表并选择字符串参数
  6. 输入用户名参数的名称。例如 devUser.
  7. 在默认值字段中,输入您的 Oracle Mobile Hub 用户名。例如samir.developer@example.com.
  8. 单击添加构建参数下拉列表并选择口令参数
  9. 输入口令参数的名称,例如 devPassword
  10. 在默认值字段中,输入 Oracle Mobile Hub 用户名的口令。
  11. 单击保存

配置 Unix Shell 构建器

Shell 构建器是一个 Bash 脚本,只要触发了构建就在构建系统上运行该脚本。然后,它将相关性安装到 Oracle Mobile Hub

脚本针对在 Oracle Developer Cloud Service 中创建项目时设置的 Git 资料档案库中的源运。请注意,如果脚本在任意时间点失败,则将退出并且不部署代码。

  1. 登录到 Oracle Developer Cloud Service 控制台,然后打开项目。
  2. 在导航面板中,单击建,然后选择要为其设置参数的构建。
    此时将打开“构建设置 ”页。
  3. 单击配置
    此时将打开“作业配置 ”页。
  4. 单击构建器选项卡。
  5. 单击添加构建器下拉列表,然后选择 Unix Shell 构建器
  6. 脚本字段中,输入以下脚本:
    export NODE_PATH=node-configurations/8.9/node_modules
    npm install
    cd omce-tools
    npm install
    cd node-configurations/8.9
    npm install
    cd ../..
    node omce-deploy ../toolsConfig.json -u $devUser -p $devPassword
  7. 单击保存

下载 JavaScript Scaffold

在创建 API 骨架之后,系统会为 API 代码创建可以下载到 Zip 文件中的 API 代码创建 scaffold。

Scaffold 包含用于实施 API 的初始结构和文件,该结构和文件将用作定制的起点。您需要提取文件并将其放置在工作目录中。

  1. Oracle Mobile Hub 中,打开要排除的 API。
  2. 在 API 导航面板中,单击实施
  3. 单击 JavaScript Scaffold,即将 scaffold 文件下载到您的计算机。
  4. 将您的 API 的 package.jsontoolsConfig.json.js 文件提取到工作目录。这是在克隆 Git 资料档案库时创建的同一目录,其中包含.git 目录。

安装和配置开发工具

Oracle 提供了用于从命令行将自定义 API 实施上载到 Oracle Mobile Hub 的工具。将工具添加到 Git 资料档案库,以便这些工具可用于 Oracle Developer Cloud Service 上的构建脚本。

这些工具包含下载过程,其中还包含一个 Oracle Mobile Hub API,可用于测试和调试开发系统上的定制 API 实施。不要求 API 使用 CI/CD 管道。有关使用 API (称为 OracleMobileAPI)的说明,请参阅 omce-tools 目录中的自述文件。

这些工具支持两个版本的 Node.js: 6.10.0和8.9.x。在此过程中,假定您使用的是8.9.4版或更高版本。

要安装和配置工具,请执行以下操作:

  1. 转至https://www.oracle.com/technetwork/topics/cloud/downloads/amce-downloads-4478270.html 并下载定制代码测试工具版本18.3.1或更高版本。请注意,此页上的文件名仍遵循旧产品名称,但它们包含的代码是最新发行版的代码。与下载内部的工具名称类似。
  2. 打开您下载的文件,将 omce-tools/omce-tools 目录的内容提取到工作目录,其中包含.git 目录。例如,如果工作目录是 test-project,则将 omce-tools/omce-tools 的内容提取到 test-project/omce-tools
  3. 安装节点配置 : 更改为 omce-tools/node-configurations/8.9目录并运行 npm install
  4. 在系统上安装 omce-tools: 更改为 omce-tools 目录并运行 npm install -g
  5. 创建一个名为 NODE_PATH 的环境变量并将其设置为 node-configurations/8.9/node_modules
  6. 请确保工具安装正确。在 omce-tools 目录中,运行 node omce-test --version。结果应为18.3.1.
  7. 更新 toolsConfig.json。下载 scaffold 时,它包含 toolsConfig.json 配置文件。使用从后端记录的信息替换 toolsConfig.json 中的占位符文本。