https://github.com/smoothbear/project-tree-action

Inspired by https://github.com/woochanleee/project-tree-generator
https://github.com/smoothbear/project-tree-action

Last synced: 1 day ago
JSON representation

Inspired by https://github.com/woochanleee/project-tree-generator

• Host: GitHub
• URL: https://github.com/smoothbear/project-tree-action
• Owner: smoothbear
• License: mit
• Created: 2022-07-04T11:27:36.000Z (over 2 years ago)
• Default Branch: main
• Last Pushed: 2022-09-07T14:22:44.000Z (about 2 years ago)
• Last Synced: 2024-10-09T03:36:06.781Z (about 1 month ago)
• Language: TypeScript
• Homepage:
• Size: 422 KB
• Stars: 6
• Watchers: 1
• Forks: 1
• Open Issues: 1
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# Project tree workflow

## Introduction

Project tree workflow is automatically changes the project directory structure in your README.md or any text file.

## How to use

### Options

| Key             | Description                                 | Default value              |

|-----------------|---------------------------------------------|----------------------------|

| title           | text to be replaced.                        |                            |

| path            | file to be replaced text.                   | README.md                  |

| message         | commit message when text updated.           | update: project tree       |

| email           | to be committed user email.                 | none                       |

| username        | to be committed user name.                  | none                       |

| token           | repository token or user token.             | none                       |

| branches        | created branch's name for update.           |                            |

| target-branches | pr to target branches.                      | main                       |

| pr              | create pull request when branch is updated. |                            |

| pr-title        | pull request title                          | update: project structure. |

### Example Workflow

```yml

name: Update to README

on:

  push:

    branches: [ "main" ]

jobs:

  change-readme:

    runs-on: ubuntu-latest

    steps:

      - uses: actions/checkout@v3

      - name: Insert project tree

        uses: smoothbear/project-tree-action@main

        with:

          email: to be committed email

          username: to be committed username

          token: ${{ secrets.GITHUB_TOKEN }}

```

### Project Structure

```.

├── LICENSE

├── README.md

├── action.yml

├── dist

│   └── project

│       └── index.js

├── jest-config.js

├── package-lock.json

├── package.json

├── src

│   └── main.ts

└── tsconfig.json

3 directories, 9 files

```