wadackel / github-pr-diff-tree

:evergreen_tree: This action provide a comment that displays the diff of the pull request in a tree format.

github-pr-diff-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

Basic:

# .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 👏

1. Fork (https://github.com/wadackel/github-pr-diff-tree) 🎉
2. Create a feature branch ☕
3. Run test suite with the $ npm test command and confirm that it passes ⚡
4. Commit your changes 📝
5. Rebase your local changes against the main branch 💡
6. Create new Pull Request 💌

Bugs, feature requests and comments are more than welcome in the issues.

License

MIT © wadackel