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.
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
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
The directory (and its children) that you want to visualize in the diagram.
For example: ./src/
Default: ./
The maximum number of nested folders to show files within. A higher number will take longer to render.
Default: 9
The commit message to use when updating the diagram. Useful for skipping CI. For example: Updating diagram [skip ci]
Default: Repo visualizer: updated diagram
The branch name to push the diagram to (branch will be created if it does not yet exist).
For example: diagram
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@0.5.0
with:
output_file: "images/diagram.svg"
excluded_paths: "dist,node_modules"