Compartir a través de

Uso de Dev Proxy con Acciones de GitHub

De un vistazo
Objetivo: Uso del Proxy de desarrollo en Acciones de GitHub
Tiempo: 15 minutos
Complementos: Varios
Requisitos previos:Configuración del proxy de desarrollo, repositorio de GitHub

Para integrar Dev Proxy en los flujos de trabajo de GitHub Actions, use Dev Proxy Actions.

Configuración del proxy de desarrollo en el flujo de trabajo de Acciones de GitHub

Para instalar e iniciar el proxy de desarrollo, use la acción setup.

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

Instalación e inicio del proxy de desarrollo en modo de grabación

Para iniciar Dev Proxy en modo de grabación, fije la entrada auto-record en true. Esta configuración permite a Dev Proxy capturar solicitudes y respuestas para su posterior procesamiento.

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

Instalación e inicio del proxy de desarrollo mediante un archivo de configuración específico

De forma predeterminada, se usa el archivo de configuración predeterminado del proxy de desarrollo, devproxyrc.json. Para utilizar un archivo de configuración específico de Dev Proxy, establezca la entrada config-file en la ruta de acceso de su archivo de configuración.

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

Instalación e inicio del proxy de desarrollo con un archivo de registro personalizado

De forma predeterminada, la salida del proxy de desarrollo se registra en el archivo devproxy.log en el directorio de trabajo. Para especificar un archivo de registro personalizado, establezca la 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

Instalación de una versión específica del proxy de desarrollo

De forma predeterminada, la setup acción instala la versión más reciente del proxy de desarrollo. Si desea instalar una versión específica, puede especificar la version entrada.

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

Instalar solo el proxy de desarrollo

Para instalar el proxy de desarrollo sin iniciarlo, establezca la entrada auto-start en false.

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

Iniciar el proxy de desarrollo manualmente

Para iniciar Dev Proxy manualmente después de la instalación, utilice la acción start.

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

La start acción se comporta de forma similar a la setup acción, pero no se puede usar para instalar el proxy de desarrollo. Comparte las mismas entradas (excepto para version) y salidas que la setup acción.

Deshabilitar la detención automática del proxy de desarrollo

De forma predeterminada, las acciones setup y start detienen el proxy de desarrollo automáticamente después de completar el trabajo. Para deshabilitar la detención automática del proxy de desarrollo una vez completado el trabajo, establezca la entrada auto-stop en false.

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

Detener el proxy de desarrollo manualmente

Si desea detener el proxy de desarrollo manualmente, use la acción stop. Esta acción es útil si desea generar informes y cargarlos como artefactos o ejecutar proxy de desarrollo con una configuración 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 la grabación manualmente

Para iniciar la grabación manualmente, use la acción start con la entrada auto-record establecida en true.

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

Detener la grabación manualmente

Para detener la grabación manualmente, use la record-stop acción .

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

Obtención de la dirección URL de la instancia de Proxy de desarrollo en ejecución

Para obtener la dirección URL de la instancia de proxy de desarrollo en ejecución, use la salida proxy-url de la acción setup o start. Utilice la sintaxis steps.<step_id>.outputs.proxy-url, donde <step_id> es el ID del paso que realiza la acción.

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

Obtención de la dirección URL de la API de proxy de desarrollo

Para obtener la URL de la API del proxy de desarrollo, use la salida api-url de la acción setup o start. Utilice la sintaxis steps.<step_id>.outputs.api-url, donde <step_id> es el ID del paso que realiza la acción.

- 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 también

  • Last updated on