dependency cruiser report action

Отчет о зависимости

Действия GitHub, которые сообщают о визуализации зависимостей от измененных файлов, каждая запросы на вытягивание.

В этом действии используется зависимость-квейзер для вывода синтаксиса Mermaid.js. Вдохновленный настреем-отчеты-действие.

Использование

Установите в своем проекте

npm install --save-dev dependency-cruiser

Настройка зависимости в мастере

npm run depcruise --init

Создайте новое действие в разделе .github/workflows .

 name : ' depcruise '
on :
  pull_request :

jobs :
  report :
    permissions :
      pull-requests : write
    runs-on : ubuntu-latest
    steps :
      - uses : MH4GF/dependency-cruiser-report-action@v2 

Расширенное использование

Указание файла конфигурации

Это действие автоматически обнаруживает файл конфигурации зависимостей-крови ( .dependency-cruiser.js и т. Д.), Но вы можете указать свой собственный файл правил.

 with :
  config-file : my-rules.json

Для получения дополнительной информации о файле конфигурации см. Официальную документацию

Настройка круизного сценария

Это действие автоматически добавляет необходимые флаги в ваш круизный скрипт на основе менеджера пакетов. Например, если вы используете пряжу, сценарий по умолчанию:

yarn run -s depcruise

Таким образом, вам не нужно указывать дополнительные флаги - действие будет обрабатывать их автоматически. Итак, после добавления необходимых флагов, действие запустит эту команду:

 --output-type mermaid --config ${SPECIFIED_CONFIG_FILE} ${DIFF_FILE_A DIFF_FILE_B ...etc}

Но вы можете использовать дополнительные варианты:

 with :
  cruise-script : yarn run -s depcruise --exclude "^lib"

Использование с bun , npm или pnpm

Это действие будет автоматически загружать зависимости (по умолчанию пряжа), но вы также можете указать bun , npm или pnpm :

 with :
  package-manager : npm

или

 with :
  package-manager : pnpm

Настройка рабочего каталога

Если вы хотите запустить это действие в другом каталоге, укажите working-directory :

 with :
  working-directory : <dir> 

Совместимость

Это действие требует зависимости-крейзер V11.10.0 или новее.