{"id":25132236,"url":"https://github.com/mh4gf/dependency-cruiser-report-action","last_synced_at":"2025-07-31T10:04:37.149Z","repository":{"id":37833611,"uuid":"492461968","full_name":"MH4GF/dependency-cruiser-report-action","owner":"MH4GF","description":"A GitHub Actions that report to visualize dependencies of changed files each pull requests.","archived":false,"fork":false,"pushed_at":"2025-04-01T02:14:26.000Z","size":4843,"stargazers_count":38,"open_issues_count":5,"forks_count":4,"subscribers_count":1,"default_branch":"main","last_synced_at":"2025-04-18T21:11:18.502Z","etag":null,"topics":["architecture-diagram","circular-dependencies","dependencies","dependency-cruiser","github-actions","javascript","jsx","mermaidjs","static-analysis","typescript","vue"],"latest_commit_sha":null,"homepage":"","language":"TypeScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/MH4GF.png","metadata":{"files":{"readme":"README.md","changelog":"CHANGELOG.md","contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":"CODEOWNERS","security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2022-05-15T11:03:33.000Z","updated_at":"2025-04-01T02:14:17.000Z","dependencies_parsed_at":"2023-11-25T15:23:52.437Z","dependency_job_id":"96e9d970-f41b-4800-bf09-640d2f3b9579","html_url":"https://github.com/MH4GF/dependency-cruiser-report-action","commit_stats":{"total_commits":207,"total_committers":4,"mean_commits":51.75,"dds":0.5410628019323671,"last_synced_commit":"a8f827d0d79667cf4e6379164bd7ab001e932512"},"previous_names":[],"tags_count":36,"template":false,"template_full_name":"actions/typescript-action","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/MH4GF%2Fdependency-cruiser-report-action","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/MH4GF%2Fdependency-cruiser-report-action/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/MH4GF%2Fdependency-cruiser-report-action/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/MH4GF%2Fdependency-cruiser-report-action/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/MH4GF","download_url":"https://codeload.github.com/MH4GF/dependency-cruiser-report-action/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":250513380,"owners_count":21443200,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["architecture-diagram","circular-dependencies","dependencies","dependency-cruiser","github-actions","javascript","jsx","mermaidjs","static-analysis","typescript","vue"],"created_at":"2025-02-08T14:17:20.536Z","updated_at":"2025-04-23T20:43:35.879Z","avatar_url":"https://github.com/MH4GF.png","language":"TypeScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"# dependency-cruiser report\n\nA GitHub Actions that report to visualize dependencies of changed files each pull requests.\n\n[![test](https://github.com/MH4GF/dependency-cruiser-report-action/actions/workflows/test.yml/badge.svg)](https://github.com/MH4GF/dependency-cruiser-report-action/actions/workflows/test.yml)\n\n![sample](./docs/assets/sample-light.png#gh-light-mode-only)![sample](./docs/assets/sample-dark.png#gh-dark-mode-only)\n\nThis action uses [dependency-cruiser](https://github.com/sverweij/dependency-cruiser) to output syntax of [mermaid.js](https://github.com/mermaid-js/mermaid). Inspired by [jest-coverage-report-action](https://github.com/ArtiomTr/jest-coverage-report-action).\n\n## usage\n\n### Install in your project\n\n```bash\nnpm install --save-dev dependency-cruiser\n```\n\n### Setup dependency-cruiser in the wizard\n\n```bash\nnpm run depcruise --init\n```\n\n### Create new action under `.github/workflows` .\n\n```yaml\nname: 'depcruise'\non:\n  pull_request:\n\njobs:\n  report:\n    permissions:\n      pull-requests: write\n    runs-on: ubuntu-latest\n    steps:\n      - uses: MH4GF/dependency-cruiser-report-action@v2\n```\n\n## Advanced Usage\n\n### Specifying config file\n\nThis action automatically detects dependency-cruiser config file ( `.dependency-cruiser.js`, etc.), but you can specify your own rules file.\n\n```yaml\nwith:\n  config-file: my-rules.json\n```\n\nFor more information on config file, please see [the official documentation](https://github.com/sverweij/dependency-cruiser/blob/develop/doc/cli.md#--config---validate)\n\n### Customizing cruise script\n\nThis action automatically adds necessary flags to your cruise script based on package manager. For example, if you are using yarn, the default script is:\n\n```bash\nyarn run -s depcruise\n```\n\nSo you don't need to specify additional flags - action will handle them automatically. So, after adding necessary flags, action will run this command:\n\n```bash\n --output-type mermaid --config ${SPECIFIED_CONFIG_FILE} ${DIFF_FILE_A DIFF_FILE_B ...etc}\n```\n\nBut you can use additional options:\n\n```yaml\nwith:\n  cruise-script: yarn run -s depcruise --exclude \"^lib\"\n```\n\n### Usage with `bun`, `npm` or `pnpm`\n\nThis action will automatically download dependencies (default is yarn), but you can also specify `bun`, `npm` or `pnpm`:\n\n```yaml\nwith:\n  package-manager: npm\n```\n\nor\n\n```yaml\nwith:\n  package-manager: pnpm\n```\n\n### Customizing working directory\n\nIf you want to run this action in another directory, specify `working-directory`:\n\n```yaml\nwith:\n  working-directory: \u003cdir\u003e\n```\n\n## Compatibility\n\nThis action requires dependency-cruiser v11.10.0 or newer.\n\n## Articles\n\n- [Visualize TypeScript Dependencies of Changed Files in a Pull Request Using dependency-cruiser-report-action](https://dev.to/mh4gf/visualize-typescript-dependencies-of-changed-files-in-a-pull-request-using-127j)\n- [(JA)dependency-cruiser-report-actionでPRの変更ファイルの依存関係を可視化してコメントする](https://zenn.dev/mh4gf/articles/12fcdcba14e576)\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fmh4gf%2Fdependency-cruiser-report-action","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fmh4gf%2Fdependency-cruiser-report-action","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fmh4gf%2Fdependency-cruiser-report-action/lists"}