jaywcjlove/github-action-folder-tree

View the folder directory tree structure, similar to the output of the tree command

Print Folder Tree

View the folder directory tree structure, similar to the output of the tree command

Example Usage

- 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'

Inputs

• 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

Outputs

• content Directory tree structure text

See Also

• Github Release Changelog Generator A GitHub Action that compares the commit differences between two branches
• Create Tags From Auto create tags from commit or package.json.
• Github Action Contributors Github action generates dynamic image URL for contributor list to display it!
• Generated Badges Create a badge using GitHub Actions and GitHub Workflow CPU time (no 3rd parties servers)
• Create Coverage Badges Create coverage badges from coverage reports. (no 3rd parties servers)
• Github Action package Read and modify the contents of package.json.
• Github Action EJS A github action to render a ejs template using github context.
• Modify File Content Replace text content and submit content.

License

Licensed under the MIT License.