dependency cruiser report action

Laporan Pengambilan Ketergantungan

Tindakan GitHub yang melaporkan untuk memvisualisasikan dependensi file yang diubah setiap permintaan tarik.

Tindakan ini menggunakan ketergantungan-kruiser untuk output sintaks putriid.js. Terinspirasi oleh aksi jest-coverage-report-action.

penggunaan

Instal di proyek Anda

npm install --save-dev dependency-cruiser

Pengaturan Ketergantungan-Pemerkas di Wizard

npm run depcruise --init

Buat tindakan baru di bawah .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 

Penggunaan lanjutan

Menentukan file konfigurasi

Tindakan ini secara otomatis mendeteksi file konfigurasi ketergantungan-kruer ( .dependency-cruiser.js , dll.), Tetapi Anda dapat menentukan file aturan Anda sendiri.

 with :
  config-file : my-rules.json

Untuk informasi lebih lanjut tentang file konfigurasi, silakan lihat dokumentasi resmi

Menyesuaikan skrip pelayaran

Tindakan ini secara otomatis menambahkan bendera yang diperlukan ke skrip pelayaran Anda berdasarkan paket manajer. Misalnya, jika Anda menggunakan benang, skrip default adalah:

yarn run -s depcruise

Jadi Anda tidak perlu menentukan bendera tambahan - tindakan akan menanganinya secara otomatis. Jadi, setelah menambahkan bendera yang diperlukan, tindakan akan menjalankan perintah ini:

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

Tetapi Anda dapat menggunakan opsi tambahan:

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

Penggunaan dengan bun , npm atau pnpm

Tindakan ini akan secara otomatis mengunduh dependensi (default adalah benang), tetapi Anda juga dapat menentukan bun , npm atau pnpm :

 with :
  package-manager : npm

atau

 with :
  package-manager : pnpm

Menyesuaikan direktori kerja

Jika Anda ingin menjalankan tindakan ini di direktori lain, tentukan working-directory :

 with :
  working-directory : <dir> 

Kesesuaian

Tindakan ini membutuhkan ketergantungan-kruiser V11.10.0 atau yang lebih baru.