Partilhar via


Usar proxy de desenvolvimento com ações do GitHub

De relance
Objetivo: Usar o Proxy de Desenvolvimento nas Ações do GitHub
Tempo: 15 minutos
Plugins: Vários
Pré-requisitos:Configurar Dev Proxy, repositório GitHub

Para integrar o Dev Proxy nos seus fluxos de trabalho do GitHub Actions, use Dev Proxy Actions.

Configurar o Proxy de Desenvolvimento em seu fluxo de trabalho de Ações do GitHub

Para instalar e iniciar o Dev Proxy, utilize a ação setup.

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

Instalar e iniciar o Dev Proxy no modo de gravação

Para iniciar o Dev Proxy no modo de gravação, defina a auto-record entrada como true. Essa configuração permite que o Dev Proxy capture solicitações e respostas para processamento posterior.

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

Instalar e iniciar o Dev Proxy usando um arquivo de configuração específico

Por padrão, o arquivo de configuração padrão do Dev Proxy é usado, devproxyrc.json. Para utilizar um ficheiro de configuração Dev Proxy específico, defina a entrada config-file para o caminho do seu ficheiro de configuração.

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

Instalar e iniciar o Dev Proxy com um arquivo de log personalizado

Por padrão, a saída do Dev Proxy é registrada em devproxy.log arquivo no diretório de trabalho. Para especificar um arquivo de log personalizado, defina a log-file entrada.

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

Instalar uma versão específica do Dev Proxy

Por padrão, a setup ação instala a versão mais recente do Dev Proxy. Se você quiser instalar uma versão específica, você pode especificar a version entrada.

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

Instalar apenas o Dev Proxy

Para instalar o Dev Proxy sem iniciá-lo, defina a auto-start entrada como false.

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

Iniciar o Dev Proxy manualmente

Para iniciar o Dev Proxy manualmente após a instalação, use a start ação.

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

A ação start comporta-se de forma semelhante à ação setup, mas não pode ser utilizada para instalar o Dev Proxy. Ele compartilha as mesmas entradas (exceto para version) e saídas que a setup ação.

Desativar a parada automática do Dev Proxy

Por padrão, as ações setup e start param o Proxy Dev automaticamente após a conclusão do trabalho. Para desativar a interrupção automática do Proxy de Desenvolvimento após a conclusão do trabalho, defina a auto-stop entrada como false.

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

Parar o Proxy de Desenvolvimento manualmente

Se você quiser parar o Dev Proxy manualmente, use a stop ação. Essa ação é útil se você quiser gerar relatórios e carregá-los como artefatos ou executar o Dev Proxy com uma configuração diferente.

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

Iniciar a gravação manualmente

Para iniciar a gravação manualmente, use a start ação com a auto-record entrada definida como true.

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

Parar a gravação manualmente

Para parar a gravação manualmente, use a record-stop ação.

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

Obter a URL da instância do Proxy de Desenvolvimento em execução

Para obter o URL da instância do Proxy de Desenvolvimento em execução, utilize a saída da ação proxy-url ou setup. Use a sintaxe steps.<step_id>.outputs.proxy-url, onde <step_id> é o ID da etapa que executa a ação.

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

Obter a URL da API de proxy de desenvolvimento

Para obter a URL da API de Proxy de Desenvolvimento, use a saída da ação api-url, setup ou start. Use a sintaxe steps.<step_id>.outputs.api-url, onde <step_id> é o ID da etapa que executa a ação.

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

Consulte também