Dela via


Använda Dev Proxy med GitHub Actions

Överblick
Mål: Använda Dev Proxy i GitHub Actions
Tid: 15 minuter
Plugins: Olika
Krav:Konfigurera Dev Proxy, GitHub-lagringsplats

Om du vill integrera Dev Proxy i dina GitHub Actions-arbetsflöden använder du Dev Proxy Actions.

Konfigurera Dev Proxy i ditt GitHub Actions-arbetsflöde

Använd setup-åtgärden för att installera och starta Dev Proxy.

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

Installera och starta Dev Proxy i inspelningsläge

Om du vill starta Dev Proxy i inspelningsläge anger du auto-record indata till true. Med den här konfigurationen kan Dev Proxy samla in begäranden och svar för vidare bearbetning.

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

Installera och starta Dev Proxy med en specifik konfigurationsfil

Som standard används standardkonfigurationsfilen för Dev Proxy, devproxyrc.json. Om du vill använda en specifik Dev Proxy-konfigurationsfil anger du config-file indata till sökvägen till konfigurationsfilen.

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

Installera och starta Dev Proxy med en anpassad loggfil

Som standard loggas Dev Proxy-utdata till devproxy.log fil i arbetskatalogen. För att ange en anpassad loggfil, ställ in log-file-indatan.

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

Installera en specifik version av Dev Proxy

Som standard installerar åtgärden setup den senaste versionen av Dev Proxy. Om du vill installera en viss version kan du ange version input.

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

Installera endast Dev Proxy

Om du vill installera Dev Proxy utan att starta den anger du auto-start indata till false.

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

Starta Dev Proxy manuellt

Om du vill starta Dev Proxy manuellt efter installationen använder du åtgärden start .

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

Åtgärden start fungerar på samma sätt som åtgärden setup , men den kan inte användas för att installera Dev Proxy. Den delar samma indata (förutom ) versionoch utdata som åtgärden setup .

Inaktivera automatisk stopp av Dev Proxy

Som standardinställning stoppar åtgärderna setup och start Dev Proxy automatiskt när jobbet har slutförts. Om du vill inaktivera det automatiska stoppet av Dev Proxy när jobbet har slutförts anger du auto-stop indata till false.

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

Stoppa Dev Proxy manuellt

Om du vill stoppa Dev Proxy manuellt använder du åtgärden stop . Den här åtgärden är användbar om du vill generera rapporter och ladda upp dem som artefakter eller köra Dev Proxy med en annan konfiguration.

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

Börja spela in manuellt

Om du vill börja spela in manuellt använder du start kommandot med indata inställt på auto-record till true.

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

Sluta spela in manuellt

Om du vill sluta spela in manuellt använder du åtgärden record-stop .

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

Hämta URL:en för den dev proxyinstans som körs

Om du vill hämta URL:en för Dev-proxyinstansen som körs, använder du proxy-url utdata från åtgärden setup eller start. Använd steps.<step_id>.outputs.proxy-url syntax, där <step_id> är ID för steget som kör åtgärden.

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

Hämta URL:en för Dev Proxy-API:et

Om du vill hämta URL:en för Dev Proxy API:n, använder du utdata från åtgärden api-url eller setup. Använd steps.<step_id>.outputs.api-url syntax, där <step_id> är ID för steget som kör åtgärden.

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

Se även