一目了然
目標： 在 GitHub Actions 中使用 Dev Proxy
時間： 15分鐘
插件： 各種
前置條件：設定 Dev Proxy，GitHub 倉庫
若要將 Dev Proxy 整合到 GitHub Actions 流中，請使用 Dev Proxy Actions。
在您的 GitHub Actions 工作流程中設置開發代理伺服器
若要安裝和啟動 Dev Proxy，請使用 setup 動作。
- name: Setup Dev Proxy
uses: dev-proxy-tools/actions/setup@v1
在錄製模式中安裝和啟動Dev Proxy
若要在錄製模式中啟動 Dev Proxy，請將 auto-record 輸入設定為 true。 此設定可讓開發人員 Proxy 擷取要求和回應，以進行進一步處理。
- name: Start Dev Proxy
uses: dev-proxy-tools/actions/start@v1
with:
auto-record: true
使用特定組態檔安裝並啟動 Dev Proxy
根據預設，會使用預設的 Dev Proxy 組態檔。 devproxyrc.json 若要使用特定的 Dev Proxy 組態檔，請將 config-file 輸入設定為組態檔的路徑。
- name: Start Dev Proxy with config
uses: dev-proxy-tools/actions/start@v1
with:
config-file: .devproxy/my-config.json
使用自訂記錄檔安裝並啟動Dev Proxy
根據預設，開發人員 Proxy 輸出會記錄到工作目錄中devproxy.log檔案。 若要指定自訂記錄檔，請設定 log-file 輸入。
- name: Start Dev Proxy with custom log file
uses: dev-proxy-tools/actions/start@v1
with:
log-file: .devproxy/custom-devproxy.log
安裝特定版本的 Dev Proxy
根據預設， setup 動作會安裝最新版本的 Dev Proxy。 如果您要安裝特定版本，您可以指定 version 輸入。
- name: Setup Dev Proxy with specific version
uses: dev-proxy-tools/actions/setup@v1
with:
version: 0.29.2
僅安裝開發代理
若要安裝 Dev Proxy 而不啟動它，請將 auto-start 輸入設定為 false。
- name: Install Dev Proxy
uses: dev-proxy-tools/actions/setup@v1
with:
auto-start: false
手動啟動 Dev Proxy
若要在安裝之後手動啟動開發 Proxy，請使用 start 動作。
- name: Start Dev Proxy manually
uses: dev-proxy-tools/actions/start@v1
動作 start 的行為與 setup 動作類似，但無法用來安裝開發 Proxy。 它會共用相同的輸入（除了 version除外），並輸出做為 setup 動作。
禁止自動停止 Dev Proxy
根據預設， setup 和 start 動作會在作業完成之後自動停止 Dev Proxy。 若要在作業完成之後停用自動停止 Dev Proxy，請將 auto-stop 輸入設定為 false。
- name: Setup Dev Proxy without auto-stop
uses: dev-proxy-tools/actions/setup@v1
with:
auto-stop: false
手動停止開發 Proxy
如果您想要手動停止開發 Proxy，請使用 stop 動作。 如果您想要產生報表並將其上傳為成品，或使用不同的組態執行 Dev Proxy，此動作會很有用。
- name: Stop Dev Proxy manually
uses: dev-proxy-tools/actions/stop@v1
- name: Upload Dev Proxy reports
uses: actions/upload-artifact@v4
with:
name: Reports
path: ./*Reporter*
手動開始錄製
若要手動開始錄製，請使用start，並將auto-record輸入設定為true。
- name: Start Dev Proxy in recording mode
uses: dev-proxy-tools/actions/record-start@v1
手動停止錄製
若要手動停止錄製，請使用 record-stop 動作。
- name: Stop recording
uses: dev-proxy-tools/actions/record-stop@v1
取得執行中 Dev Proxy 實例的 URL
若要取得執行中 Dev Proxy 實例的 URL，請使用proxy-url或setup動作所產生的start輸出。 使用 steps.<step_id>.outputs.proxy-url 語法，其中 <step_id> 是執行動作之步驟的標識符。
- name: Setup Dev Proxy
id: setup-devproxy
uses: dev-proxy-tools/actions/setup@v1
- name: Get Dev Proxy URL
run: echo "Dev Proxy URL: ${{ steps.setup-devproxy.outputs.proxy-url }}"
取得開發 Proxy API 的 URL
若要取得開發 Proxy API 的 URL，請使用 api-url 或 setup 動作的start輸出。 使用 steps.<step_id>.outputs.api-url 語法，其中 <step_id> 是執行動作之步驟的標識符。
- name: Setup Dev Proxy
id: setup-devproxy
uses: dev-proxy-tools/actions/setup@v1
- name: Get Dev Proxy API URL
run: echo "Dev Proxy API URL: ${{ steps.setup-devproxy.outputs.api-url }}"
