Použijte vývojový proxy server s GitHub Actions

Na první pohled
Cílem: Použít Dev Proxy v GitHub Actions
Čas: 15 minut
Pluginy: Různé
Požadavky:Nastavení dev proxy serveru, úložiště GitHub

Pokud chcete integrovat Dev Proxy do pracovních postupů GitHub Actions, použijte Dev Proxy Actions.

Nastavte Dev Proxy v pracovním postupu GitHub Actions

K instalaci a spuštění dev Proxy použijte setup akci.

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

Instalace a spuštění Dev Proxy v režimu nahrávání

Pokud chcete spustit Dev Proxy v režimu nahrávání, nastavte auto-record vstup na true. Tato konfigurace umožňuje dev proxy zachytávat požadavky a odpovědi pro další zpracování.

- name: Start Dev Proxy
  uses: dev-proxy-tools/actions/start@v1
  with:
    auto-record: true

Instalace a spuštění dev Proxy pomocí konkrétního konfiguračního souboru

Ve výchozím nastavení se používá výchozí konfigurační soubor proxy serveru Dev devproxyrc.json. Pokud chcete použít konkrétní konfigurační soubor dev proxy serveru, nastavte config-file vstup na cestu ke konfiguračnímu souboru.

- name: Start Dev Proxy with config
  uses: dev-proxy-tools/actions/start@v1
  with:
    config-file: .devproxy/my-config.json

Nainstalujte a spusťte Dev Proxy pomocí vlastního souboru protokolu

Ve výchozím nastavení se výstup dev proxy zaprotokoluje do devproxy.log souboru v pracovním adresáři. Pokud chcete zadat vlastní soubor protokolu, nastavte log-file vstup.

- name: Start Dev Proxy with custom log file
  uses: dev-proxy-tools/actions/start@v1
  with:
    log-file: .devproxy/custom-devproxy.log

Instalace konkrétní verze dev proxy serveru

Ve výchozím nastavení akce setup nainstaluje nejnovější verzi dev proxy serveru. Pokud chcete nainstalovat konkrétní verzi, můžete zadat version vstup.

- name: Setup Dev Proxy with specific version
  uses: dev-proxy-tools/actions/setup@v1
  with:
    version: 0.29.2

Instalovat jenom Dev Proxy

Pokud chcete nainstalovat Dev Proxy bez spuštění, nastavte auto-start vstup na false.

- name: Install Dev Proxy
  uses: dev-proxy-tools/actions/setup@v1
  with:
    auto-start: false

Ruční spuštění dev proxy serveru

Pokud chcete dev proxy spustit ručně po instalaci, použijte start akci.

- name: Start Dev Proxy manually
  uses: dev-proxy-tools/actions/start@v1

Akce start se chová podobně jako setup akce, ale nedá se použít k instalaci dev proxy serveru. Sdílí stejné vstupy (s výjimkou version) a výstupy, jako akce setup.

Zakázání automatického zastavování dev proxy serveru

Ve výchozím nastavení se akce setup a start automaticky zastaví po dokončení úlohy Dev Proxy. Pokud chcete po dokončení úlohy zakázat automatické zastavení Dev Proxy, nastavte vstup na auto-stopfalse.

- name: Setup Dev Proxy without auto-stop
  uses: dev-proxy-tools/actions/setup@v1
  with:
    auto-stop: false

Ruční zastavení dev proxy serveru

Pokud chcete Dev Proxy zastavit ručně, použijte akci stop. Tato akce je užitečná, pokud chcete vygenerovat sestavy a nahrát je jako artefakty, nebo spustit Dev Proxy s jinou konfigurací.

- 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*

Ruční spuštění nahrávání

Chcete-li spustit nahrávání ručně, použijte akci start se vstupem nastaveným na auto-recordtrue.

- name: Start Dev Proxy in recording mode
  uses: dev-proxy-tools/actions/record-start@v1

Ruční zastavení nahrávání

Pokud chcete nahrávání zastavit ručně, použijte record-stop akci.

- name: Stop recording
  uses: dev-proxy-tools/actions/record-stop@v1

Získání adresy URL spuštěné instance dev Proxy

Pokud chcete získat adresu URL spuštěné instance Dev Proxy, použijte výstup proxy-url z akce setup nebo akce start. Použijte steps.<step_id>.outputs.proxy-url syntaxi, kde <step_id> je ID kroku, který akci spouští.

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

Získání adresy URL rozhraní DEV Proxy API

Pokud chcete získat adresu URL rozhraní Dev Proxy API, použijte api-url výstup z akce setup nebo start. Použijte steps.<step_id>.outputs.api-url syntaxi, kde <step_id> je ID kroku, který akci spouští.

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

Viz také

  • Last updated on