View the folder directory tree structure, similar to the output of the tree command
- name: Print Folder Tree
uses: jaywcjlove/github-action-folder-tree@main
with:
exclude: "node_modules|dist|.git|.husky"
path: ./src
depth: 2
Output Project Structure
├── .lintstagedrc
├── LICENSE
├── README.md
├── action.yml
├─> build
├── package-lock.json
├── package.json
├── renovate.json
├─> src
│ └── index.ts
└── tsconfig.json
- name: Print Folder Tree
uses: jaywcjlove/github-action-folder-tree@main
id: tree
with:
exclude: "node_modules|dist|.git|.husky"
path: ./src
depth: 2
- name: Modify README.md
uses: jaywcjlove/github-action-modify-file-content@main
with:
path: README.md
body: ${{ steps.tree.outputs.content }}
Configure dree using JSON
- name: Print Folder Tree
uses: jaywcjlove/github-action-folder-tree@main
with:
config: './docs/dree-config.json'
- path Folder path. (default ./)
- depth Scan the maximum depth reachable for the given path (default 5)
- exclude Pass a regex string to exclude directories from printing
- config The path to the dree configuration file
- content Directory tree structure text
Licensed under the MIT License.