次の方法で共有

GitHub Actions で開発プロキシを使用する

概要
目標： GitHub Actions で開発プロキシを使用する
時間: 15 分
プラグイン： 各種
前提条件:開発プロキシ、GitHub リポジトリを設定する

開発プロキシを GitHub Actions ワークフローに統合するには、 Dev Proxy Actions を使用します。

GitHub Actions ワークフローで開発プロキシを設定する

開発プロキシをインストールして起動するには、 setup アクションを使用します。

- name: Setup Dev Proxy
  uses: dev-proxy-tools/actions/setup@v1

録画モードで開発プロキシをインストールして起動する

録画モードで開発プロキシを起動するには、 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

特定のバージョンの開発プロキシをインストールする

既定では、 setup アクションによって最新バージョンの開発プロキシがインストールされます。 特定のバージョンをインストールする場合は、 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 アクションを使用します。 このアクションは、レポートを生成して成果物としてアップロードする場合や、別の構成で開発プロキシを実行する場合に便利です。

- 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 }}"

こちらも参照ください

  • Last updated on