dependency cruiser report action

의존성 크루저 보고서

변경된 파일의 종속성을 시각화하기 위해보고하는 GitHub 조치 각각의 풀 요청.

이 조치는 종속성 크루저를 사용하여 Mermaid.js의 출력 구문을 사용합니다. Jest-Coverage-Report-Action에서 영감을 얻었습니다.

용법

프로젝트에 설치하십시오

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 또는 최신이 필요합니다.