dependency cruiser report action

Relatório de dependência-cruzador

Ações do GitHub que relatam para visualizar dependências de arquivos alterados cada solicitações de puxar.

Esta ação usa o cruzador de dependência para produzir sintaxe de serenda.js. Inspirado na ação de reportação de caça de brincadeira.

uso

Instale em seu projeto

npm install --save-dev dependency-cruiser

Criador de dependência de configuração no mago

npm run depcruise --init

Crie nova ação em .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 

Uso avançado

Especificando o arquivo de configuração

Essa ação detecta automaticamente o arquivo de configuração de dependência-cruzador ( .dependency-cruiser.js , etc.), mas você pode especificar seu próprio arquivo de regras.

 with :
  config-file : my-rules.json

Para obter mais informações sobre o arquivo de configuração, consulte a documentação oficial

Personalizando o script de cruzeiro

Essa ação adiciona automaticamente os sinalizadores necessários ao seu script de cruzeiro com base no gerenciador de pacotes. Por exemplo, se você estiver usando fios, o script padrão é:

yarn run -s depcruise

Portanto, você não precisa especificar sinalizadores adicionais - a ação os lidará automaticamente. Então, depois de adicionar bandeiras necessárias, a ação executará este comando:

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

Mas você pode usar opções adicionais:

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

Uso com bun , npm ou pnpm

Esta ação baixará automaticamente dependências (padrão é o YARN), mas você também pode especificar bun , npm ou pnpm :

 with :
  package-manager : npm

ou

 with :
  package-manager : pnpm

Personalizando o diretório de trabalho

Se você deseja executar esta ação em outro diretório, especifique working-directory :

 with :
  working-directory : <dir> 

Compatibilidade

Esta ação requer dependência-cruzador v11.10.0 ou mais recente.