Udostępnij przez

Korzystaj z Dev Proxy z GitHub Actions

Na pierwszy rzut oka
Cel: Użycie Dev Proxy w GitHub Actions
Czas: 15 minut
Wtyczki: Różne
Wymagania wstępne:konfigurowanie serwera proxy dev, repozytorium GitHub

Aby zintegrować usługę Dev Proxy z przepływami pracy funkcji GitHub Actions, użyj funkcji Dev Proxy Actions.

Konfigurowanie Dev Proxy w workflow GitHub Actions

Aby zainstalować i uruchomić Dev Proxy, użyj akcji setup.

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

Instalowanie i uruchamianie serwera proxy deweloperskiego w trybie nagrywania

Aby uruchomić Dev Proxy w trybie nagrywania, ustaw wejście na auto-record. Ta konfiguracja umożliwia serwerowi proxy deweloperów przechwytywanie żądań i odpowiedzi w celu dalszego przetwarzania.

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

Instalowanie i uruchamianie serwera proxy deweloperskiego przy użyciu określonego pliku konfiguracji

Domyślnie jest używany domyślny plik konfiguracji serwera proxy dev, devproxyrc.json. Aby użyć określonego pliku konfiguracji Dev Proxy, ustaw ścieżkę pliku konfiguracji jako wartość config-file.

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

Instaluj i uruchom Dev Proxy z niestandardowym plikiem dziennika

Domyślnie dane wyjściowe Dev Proxy jest zapisywane do pliku devproxy.log w katalogu roboczym. Aby określić niestandardowy plik dziennika, ustaw wartość log-file.

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

Instalowanie określonej wersji serwera proxy deweloperskiego

Domyślnie setup akcja instaluje najnowszą wersję Dev Proxy. Jeśli chcesz zainstalować określoną wersję, możesz określić version parametr.

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

Instalowanie tylko serwera proxy deweloperskiego

Aby zainstalować serwer proxy deweloperów bez uruchamiania go, ustaw wartość danych wejściowych auto-start na false.

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

Ręczne uruchamianie serwera proxy deweloperskiego

Aby ręcznie uruchomić Dev Proxy po instalacji, użyj start polecenia.

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

Akcja start działa podobnie do setup akcji, ale nie można jej użyć do zainstalowania serwera proxy deweloperskiego. Dzieli takie same dane wejściowe (z wyjątkiem version) i dane wyjściowe co akcja setup.

Wyłączanie automatycznego zatrzymywania serwera proxy deweloperskiego

Domyślnie akcje setup i start automatycznie zatrzymują "Dev Proxy" po ukończeniu zadania. Aby wyłączyć automatyczne zatrzymywanie proxy deweloperskiego po zakończeniu zadania, ustaw dane wejściowe auto-stop na false.

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

Ręczne zatrzymywanie serwera proxy deweloperskiego

Jeśli chcesz ręcznie zatrzymać Proxy deweloperski, skorzystaj z akcji stop. Ta akcja jest przydatna, jeśli chcesz wygenerować raporty i przesłać je jako artefakty lub uruchomić Dev Proxy z inną konfiguracją.

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

Ręczne rozpoczynanie rejestrowania

Aby ręcznie rozpocząć nagrywanie, wykonaj akcję start z wejściem auto-record ustawionym na true.

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

Zatrzymaj rejestrowanie ręcznie

Aby zatrzymać rejestrowanie ręcznie, użyj record-stop akcji .

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

Uzyskaj adres URL działającego wystąpienia serwera proxy Dev

Aby uzyskać adres URL uruchomionego wystąpienia serwera proxy deweloperskiego, użyj wyniku z akcji proxy-url lub setup. Użyj steps.<step_id>.outputs.proxy-url składni, gdzie <step_id> jest identyfikatorem kroku, który uruchamia akcję.

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

Pobierz adres URL interfejsu API serwera proxy deweloperskiego

Aby uzyskać adres URL interfejsu API Dev Proxy, użyj api-url wyniku z setup akcji lub start. Użyj steps.<step_id>.outputs.api-url składni, gdzie <step_id> jest identyfikatorem kroku, który uruchamia akcję.

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

Zobacz także

  • Last updated on