Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/mh4gf/dependency-cruiser-report-action
A GitHub Actions that report to visualize dependencies of changed files each pull requests.
https://github.com/mh4gf/dependency-cruiser-report-action
architecture-diagram circular-dependencies dependencies dependency-cruiser github-actions javascript jsx mermaidjs static-analysis typescript vue
Last synced: about 8 hours ago
JSON representation
A GitHub Actions that report to visualize dependencies of changed files each pull requests.
- Host: GitHub
- URL: https://github.com/mh4gf/dependency-cruiser-report-action
- Owner: MH4GF
- License: mit
- Created: 2022-05-15T11:03:33.000Z (over 2 years ago)
- Default Branch: main
- Last Pushed: 2025-02-04T18:28:30.000Z (4 days ago)
- Last Synced: 2025-02-06T16:54:19.489Z (2 days ago)
- Topics: architecture-diagram, circular-dependencies, dependencies, dependency-cruiser, github-actions, javascript, jsx, mermaidjs, static-analysis, typescript, vue
- Language: TypeScript
- Homepage:
- Size: 4.59 MB
- Stars: 36
- Watchers: 1
- Forks: 3
- Open Issues: 4
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE
- Codeowners: CODEOWNERS
Awesome Lists containing this project
README
# dependency-cruiser report
A GitHub Actions that report to visualize dependencies of changed files each pull requests.
[](https://github.com/MH4GF/dependency-cruiser-report-action/actions/workflows/test.yml)
This 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).
## usage
### Install in your project
```bash
npm install --save-dev dependency-cruiser
```
### Setup dependency-cruiser in the wizard
```bash
npm run depcruise --init
```
### Create new action under `.github/workflows` .
```yaml
name: 'depcruise'
on:
pull_request:
jobs:
report:
permissions:
pull-requests: write
runs-on: ubuntu-latest
steps:
- uses: MH4GF/dependency-cruiser-report-action@v2
```
## Advanced Usage
### Specifying config file
This action automatically detects dependency-cruiser config file ( `.dependency-cruiser.js`, etc.), but you can specify your own rules file.
```yaml
with:
config-file: my-rules.json
```
For more information on config file, please see [the official documentation](https://github.com/sverweij/dependency-cruiser/blob/develop/doc/cli.md#--config---validate)
### Customizing cruise script
This action automatically adds necessary flags to your cruise script based on package manager. For example, if you are using yarn, the default script is:
```bash
yarn run -s depcruise
```
So you don't need to specify additional flags - action will handle them automatically. So, after adding necessary flags, action will run this command:
```bash
--output-type mermaid --config ${SPECIFIED_CONFIG_FILE} ${DIFF_FILE_A DIFF_FILE_B ...etc}
```
But you can use additional options:
```yaml
with:
cruise-script: yarn run -s depcruise --exclude "^lib"
```
### Usage with `bun`, `npm` or `pnpm`
This action will automatically download dependencies (default is yarn), but you can also specify `bun`, `npm` or `pnpm`:
```yaml
with:
package-manager: npm
```
or
```yaml
with:
package-manager: pnpm
```
### Customizing working directory
If you want to run this action in another directory, specify `working-directory`:
```yaml
with:
working-directory:
```
## Compatibility
This action requires dependency-cruiser v11.10.0 or newer.
## Articles
- [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)
- [(JA)dependency-cruiser-report-actionでPRの変更ファイルの依存関係を可視化してコメントする](https://zenn.dev/mh4gf/articles/12fcdcba14e576)