Usare Dev Proxy con GitHub Actions

A colpo d'occhio
Obiettivo: Usare il Dev Proxy in GitHub Actions
Tempo: 15 minuti
Plugin: Vari
Prerequisiti: Configurareil proxy di sviluppo, il repository GitHub

Per integrare Dev Proxy nei flussi di lavoro di GitHub Actions, usare Dev Proxy Actions.

Configurare Dev Proxy nel flusso di lavoro di GitHub Actions

Per installare e avviare Dev Proxy, usare l'azione setup .

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

Installare e avviare Dev Proxy in modalità di registrazione

Per avviare Dev Proxy in modalità di registrazione, impostare l'input auto-record su true. Questa configurazione consente al proxy di sviluppo di acquisire richieste e risposte per un'ulteriore elaborazione.

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

Installare e avviare Dev Proxy usando un file di configurazione specifico

Per impostazione predefinita, viene usato il file di configurazione del proxy di sviluppo predefinito, devproxyrc.json. Per usare un file di configurazione del proxy di sviluppo specifico, imposta l'input config-file sul percorso del file di configurazione.

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

Installare e avviare Dev Proxy con un file di log personalizzato

Per impostazione predefinita, l'output di Dev Proxy viene registrato in devproxy.log file nella directory di lavoro. Per specificare un file di log personalizzato, impostare l'input log-file .

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

Installare una versione specifica di Dev Proxy

Per impostazione predefinita, l'azione setup installa la versione più recente di Dev Proxy. Se si vuole installare una versione specifica, è possibile specificare l'input version .

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

Installare solo il proxy di sviluppo

Per installare Dev Proxy senza avviarlo, impostare l'input auto-start su false.

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

Avvia manualmente il proxy di sviluppo

Per avviare manualmente Dev Proxy dopo l'installazione, usare l'azione start .

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

L'azione start si comporta in modo analogo all'azione setup , ma non può essere usata per installare Dev Proxy. Condivide gli stessi input (ad eccezione di version) e gli stessi output dell'azione setup.

Disabilitare l'arresto automatico del proxy di sviluppo

Per impostazione predefinita, le azioni setup e start arrestano automaticamente il proxy di sviluppo dopo il completamento dell'attività. Per disabilitare l'arresto automatico del proxy di sviluppo al termine del processo, impostare l'input auto-stop su false.

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

Fermare manualmente il proxy di sviluppo

se si vuole arrestare manualmente il Dev Proxy, usare l'azione stop . Questa azione è utile se si vogliono generare report e caricarli come artefatti o eseguire Dev Proxy con una configurazione diversa.

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

Avviare la registrazione manualmente

Per avviare la registrazione manualmente, usare l'azione start con l'input auto-record impostato su true.

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

Interrompere la registrazione manualmente

Per arrestare la registrazione manualmente, usare l'azione record-stop .

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

Ottenere l'URL dell'istanza del proxy di sviluppo in esecuzione

Per ottenere l'URL dell'istanza di Dev Proxy in esecuzione, usare l'output proxy-url dell'azione setup o start . Usare la sintassi steps.<step_id>.outputs.proxy-url, dove <step_id> è l'ID del passaggio che esegue l'azione.

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

Ottieni l'URL dell'API del proxy di sviluppo

Per ottenere l'URL della Dev Proxy API, utilizzare l'output api-url dall'azione setup o start. Usare la sintassi steps.<step_id>.outputs.api-url, dove <step_id> è l'ID del passaggio che esegue l'azione.

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

Vedere anche