dependency cruiser report action

รายงานการพึ่งพาเรือสำราญ

การกระทำของ GitHub ที่รายงานเพื่อให้เห็นภาพการพึ่งพาไฟล์ที่เปลี่ยนแปลงแต่ละคำขอดึงคำขอ

การกระทำนี้ใช้การพึ่งพาเรือลาดตระเวนเพื่อเอาต์พุตไวยากรณ์ของ Mermaid.js ได้รับแรงบันดาลใจจากการดำเนินการแบบ jest-coverage-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 หรือใหม่กว่า