Repo Visualizer
A GitHub Action that creates an SVG diagram of your repo. Read more in the writeup.
Please note that this is an experiment. If you have feature requests, please submit a PR or fork and use the code any way you need.
For a full demo, check out the githubocto/repo-visualizer repository.
Inputs
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
excluded_paths
A list of paths to exclude from the diagram, separated by commas.
For example: dist,node_modules
Default: node_modules,bower_components,dist,out,build,eject,.next,.netlify,.yarn,.vscode,package-lock.json,yarn.lock
Example usage
You'll need to run the actions/checkout Action beforehand, to check out the code.
- name: Checkout code
uses: actions/checkout@master
- name: Update diagram
uses: githubocto/repo-visualizer@main
with:
output_file: 'images/diagram.svg'
excluded_paths: 'dist,node_modules'