概览
目标： 在 GitHub Actions 中使用开发代理
时间： 15 分钟
插件： 各种
先决条件：设置开发代理、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
若要在录制模式下启动开发代理，请将 auto-record 输入设置为 true。 此配置允许开发代理捕获请求和响应，以便进一步处理。
- name: Start Dev Proxy
uses: dev-proxy-tools/actions/start@v1
with:
auto-record: true
使用特定配置文件安装和启动开发代理
默认情况下，使用 devproxyrc.json默认开发代理配置文件。 若要使用特定的开发代理配置文件，请将 config-file 输入设置为配置文件的路径。
- name: Start Dev Proxy with config
uses: dev-proxy-tools/actions/start@v1
with:
config-file: .devproxy/my-config.json
使用自定义日志文件安装和启动开发代理
默认情况下，开发代理输出记录到工作目录中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
仅安装开发代理
若要安装开发代理而不启动它，请将 auto-start 输入设置为 false。
- name: Install Dev Proxy
uses: dev-proxy-tools/actions/setup@v1
with:
auto-start: false
手动启动开发代理
若要在安装后手动启动开发代理，请使用 start 操作。
- name: Start Dev Proxy manually
uses: dev-proxy-tools/actions/start@v1
start 操作的行为与 setup 操作类似，但不能用于安装开发代理。 它与version操作共享相同的输入和输出（除setup外）。
禁止自动停止开发代理
默认情况下，作业完成后，setup 和 start 操作会自动停止开发代理程序。 若要在作业完成后禁止自动停止开发代理，请将 auto-stop 输入设置为 false。
- name: Setup Dev Proxy without auto-stop
uses: dev-proxy-tools/actions/setup@v1
with:
auto-stop: false
手动停止开发代理
如果要手动停止开发代理程序，请使用该 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
获取正在运行的开发代理实例的 URL
若要获取正在运行的开发代理实例的 URL，请使用 proxy-url 或 setup 操作的 start 输出。 使用 steps.<step_id>.outputs.proxy-url 语法，其中 <step_id> 是该步骤运行动作的 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 }}"
获取开发代理 API 的 URL
若要获取开发代理 API 的 URL，请使用 api-url 或 setup 操作产生的 start 输出。 使用 steps.<step_id>.outputs.api-url 语法，其中 <step_id> 是该步骤运行动作的 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 }}"
