https://github.com/wadackel/github-pr-diff-tree
:evergreen_tree: This action provide a comment that displays the diff of the pull request in a tree format.
https://github.com/wadackel/github-pr-diff-tree
github-actions productivity pull-request review-tools tree
Last synced: 7 months ago
JSON representation
:evergreen_tree: This action provide a comment that displays the diff of the pull request in a tree format.
- Host: GitHub
- URL: https://github.com/wadackel/github-pr-diff-tree
- Owner: wadackel
- License: mit
- Created: 2021-11-30T16:23:56.000Z (almost 4 years ago)
- Default Branch: main
- Last Pushed: 2024-04-12T05:19:49.000Z (over 1 year ago)
- Last Synced: 2024-05-02T00:24:12.711Z (over 1 year ago)
- Topics: github-actions, productivity, pull-request, review-tools, tree
- Language: TypeScript
- Homepage: https://github.com/marketplace/actions/pr-diff-tree
- Size: 774 KB
- Stars: 32
- Watchers: 0
- Forks: 3
- Open Issues: 20
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# github-pr-diff-tree [](https://github.com/wadackel/github-pr-diff-tree/actions/workflows/ci.yml)
:evergreen_tree: This action provide a comment that displays the diff of the pull request in a tree format.
## Motivation
When we develop a product, we make various changes to the code base. For example, add, remove, edit, and rename files.
The code diffs can be seen on GitHub's excellent review page. However, the directory structure of the changed files is sometimes overlooked by reviewers.
Therefore, this Action was created with the goal of improving the accuracy of the review by visualizing the directory structure of diffs included in a pull request in a Human-Readable format.
## Usage
See [action.yml](./action.yml)
**Basic:**
```yaml
# .github/workflows/pr-diff-tree.yml
name: 'PR Diff Tree'
on:
pull_request:
types: [opened, synchronize]
jobs:
dump:
runs-on: ubuntu-latest
steps:
- uses: wadackel/github-pr-diff-tree@v1
with:
token: ${{ secrets.GITHUB_TOKEN }}
```
## Contributing
We are always welcoming your contribution :clap:
1. Fork (https://github.com/wadackel/github-pr-diff-tree) :tada:
1. Create a feature branch :coffee:
1. Run test suite with the `$ npm test` command and confirm that it passes :zap:
1. Commit your changes :memo:
1. Rebase your local changes against the `main` branch :bulb:
1. Create new Pull Request :love_letter:
Bugs, feature requests and comments are more than welcome in the [issues](https://github.com/wadackel/github-pr-diff-tree/issues).
## License
[MIT © wadackel](./LICENSE)