關於設定 CI/CD 管線

首先,開始使用您的 API。您至少必須定義其端點,並且下載 OMC 所產生的 scaffold。Scaffold 代表最小的應用程式,您可以使用它來確保您的 CI/CD 處理作業正常運作,然後再繼續寫入並測試您自訂 API 的程式碼。

當您的 API 已就緒且您可以順利將變更植入開發人員 Cloud Service 專案中的 Git 儲存區域時,請設定專案的 CI/CD。

在 Oracle Mobile Hub 中設定 API

定義您應用程式連線的 REST 端點,以建立 API 結構。在您完成 scaffold 之後,您可以下載其定義作為 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,並將程式碼使用者自建物件傳遞至該命令檔。

  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 版本終端機 (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. 按一下齒輪圖示設定值圖示就像一組 gears。,然後按一下觸發程式以開啟「設定建立觸發程式」面板。
  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 程式碼建立不早的 API 程式碼。

Scaffold 包含 API 的初始結構和檔案,將作為您自訂項的起點。您必須解壓縮檔案,然後將它們放在您的工作目錄中。

  1. Oracle Mobile Hub 中,開啟您要使用 scaffold 的 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 上的組建命令檔使用。

此工具是下載的一部分,同時包含可用於測試和除錯您開發系統上的自訂API實行的Oracle Mobile Hub API。使用 CI/CD 管線時,不需要此 API。如需使用 API 的說明,請參閱 omce-tools 目錄中的 Readme 檔 (稱為 OracleMobileAPI)。

此工具支援 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 目錄並執行 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 中的預留位置文字。