dependency cruiser report action

تقرير التبعية-كرويزر

إجراءات github التي تقارير لتصور تبعيات الملفات التي تم تغييرها كل طلبات سحب.

يستخدم هذا الإجراء التبعية-cruiser لإخراج بناء جملة 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 

استخدام متقدم

تحديد ملف التكوين

يكتشف هذا الإجراء تلقائيًا ملف تكوين التبعية-cruiser ( .dependency-cruiser.js ، إلخ) ، ولكن يمكنك تحديد ملف القواعد الخاص بك.

 with :
  config-file : my-rules.json

لمزيد من المعلومات حول ملف التكوين ، يرجى الاطلاع على الوثائق الرسمية

تخصيص السيناريو الرحلي

يضيف هذا الإجراء تلقائيًا الأعلام اللازمة إلى برنامج Cruise Script استنادًا إلى Manager Package. على سبيل المثال ، إذا كنت تستخدم الغزل ، فإن البرنامج النصي الافتراضي هو:

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> 

التوافق

يتطلب هذا الإجراء التبعية-cruiser v11.10.0 أو الأحدث.