larslauryssensstudent/Repo Visualizer
A GitHub Action that creates an SVG diagram of your repo
View on GitHubTrust Signals
- Scorecard Score
- not yet scored
- Maintenance Recency
- Stale
- License
- None
- Runtime
- Deprecated runtime
Inputs
| name | description | required | default |
|---|---|---|---|
| output_file | A path (relative to the root of your repo) to where you would like the diagram to live. For example: images/diagram.svg. Default: diagram.svg | yes | — |
| excluded_paths | A list of paths to exclude from the diagram, separated by commas. For example: dist,node_modules | no | — |
| excluded_globs | A list of micromatch globs to exclude from the diagram, separated by semicolons. For example: **/*.png;docs/**/*.{png,ico} | no | — |
| root_path | The directory (and its children) that you want to visualize in the diagram. Default: "" (repository root directory) | no | — |
| max_depth | The maximum number of nested folders to show files within. Default: 9 | no | — |
| commit_message | The commit message to use when updating the diagram. Default: Repo visualizer: updated diagram | no | — |
| branch | The branch name to push the diagram to (branch will be created if it does not yet exist). For example: diagram | no | — |
| should_push | Whether to push the new commit back to the repository. Must be true or false. Default: true | no | true |
| artifact_name | If given, the name of an artifact to be created containing the diagram. Default: don't create an artifact. | yes | TestArtifact |
| file_colors | You can customize the colors for specific file extensions. Key/value pairs will extend the [default colors](https://github.com/githubocto/repo-visualizer/pull/src/language-colors.json). | no | {} |
Outputs
| name | description |
|---|---|
| svg | The diagram contents as text |