Поделиться через

Используйте Dev Proxy с действиями GitHub

На первый взгляд
Цель: Использование прокси-сервера разработки в GitHub Actions
Время: 15 минут
Плагины: Разные
Необходимые условия:настройка прокси-сервера разработки, репозитория GitHub

Чтобы интегрировать Dev Proxy в рабочие процессы GitHub Actions, используйте Dev Proxy Actions.

Настройка прокси-сервера разработки в рабочем процессе GitHub Actions

Чтобы установить и запустить Dev Proxy, используйте действие setup.

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

Установка и запуск прокси-сервера разработки в режиме записи

Чтобы запустить прокси-сервер разработки в режиме записи, задайте значение auto-record для параметра true. Эта конфигурация позволяет прокси-серверу разработки записывать запросы и ответы для дальнейшей обработки.

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

Установка и запуск прокси-сервера разработки с помощью определенного файла конфигурации

Используется devproxyrc.json файл конфигурации прокси-сервера разработки по умолчанию. Чтобы использовать определенный файл конфигурации прокси-сервера разработки, задайте параметр config-file как путь к вашему файлу конфигурации.

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

Установка и запуск прокси-сервера разработки с помощью пользовательского файла журнала

По умолчанию выходные данные прокси-сервера разработки записываются в devproxy.log файл в рабочем каталоге. Чтобы указать пользовательский файл журнала, задайте параметр log-file.

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

Установка определенной версии прокси-сервера разработки

По умолчанию действие устанавливает последнюю версию Dev Proxy setup. Если вы хотите установить определенную версию, можно указать входные version данные.

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

Установите только Dev Proxy

Чтобы установить Dev Proxy без его запуска, установите для auto-start значение false.

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

Запуск прокси-сервера разработки вручную

Чтобы вручную запустить Dev Proxy после установки, используйте действие start.

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

Действие start работает аналогично setup действию, но его нельзя использовать для установки прокси-сервера разработки. Он использует те же входные (за исключением version) и выходные данные, что и действие setup.

Отключение автоматической остановки разработки прокси-сервера

По умолчанию действия setup и start автоматически останавливают Dev Proxy после завершения задания. Чтобы отключить автоматическую остановку прокси-сервера разработки после завершения задания, установите для входных данных auto-stop значение false.

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

Остановить dev-прокси вручную

Если вы хотите остановить прокси-сервер разработки вручную, используйте действие stop. Это действие полезно, если вы хотите создать отчеты и отправить их в качестве артефактов или запустить прокси-сервер разработки с другой конфигурацией.

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

Запуск записи вручную

Чтобы начать запись вручную, используйте действие start с входом auto-record, установленным в true.

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

Остановка записи вручную

Чтобы остановить запись вручную, используйте record-stop действие.

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

Получение URL-адреса запущенного экземпляра прокси-сервера разработки

Чтобы получить URL-адрес запущенного экземпляра прокси-сервера разработки, воспользуйтесь выходными данными действия proxy-url или setup. Используйте синтаксис steps.<step_id>.outputs.proxy-url, где <step_id> соответствует идентификатору шага, выполняющего действие.

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

Получить URL-адрес API прокси для разработки

Чтобы получить URL-адрес API прокси-сервера разработки, используйте api-url выходные данные из setup или start действия. Используйте синтаксис steps.<step_id>.outputs.api-url, где <step_id> соответствует идентификатору шага, выполняющего действие.

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

См. также

  • Last updated on