Releases: PGSch/graph-git-repo
Releases · PGSch/graph-git-repo
v1.0.0 release
🎉 Graph Git Repo v1.0.0 Release
Visualize and Manage Your Repository Structure
🚀 New Features:
- 📊 Mermaid Diagram Generation: Automatically generates a
MERMAID_DIAGRAM.md
file for a visual representation of your repository structure. - 📝 Markdown Repository Overview: Creates a
REPO_STRUCTURE.md
file with a detailed tree structure of your repository. - 📦 Artifact Upload: Uploads the generated Markdown and Mermaid files as artifacts for easy download and review.
- 🔄 Optional PR Creation: Automatically creates a pull request to include the generated files in your repository.
🛠 Improvements:
- Enhanced customization for excluding files and directories through
exclude_patterns
. - Optimized script execution for faster generation of large repository structures.
- Clear and concise commit messages for automated PRs.
💡 How It Works:
- Add this action to your workflow with customizable inputs like
exclude_patterns
anddepth
. - The action generates the repository structure in
REPO_STRUCTURE.md
and a visual Mermaid diagram inMERMAID_DIAGRAM.md
. - Files are uploaded as artifacts, and a pull request is created if
create_pr
is set totrue
.
💻 Usage:
- Include the action in your GitHub workflow:
uses: PGSch/graph-git-repo@v1 with: exclude_patterns: '.git|node_modules|*.log|*.env' depth: '2' create_pr: 'true' openai_api_key: ${{ secrets.OPENAI_API_KEY }} github_token: ${{ secrets.GITHUB_TOKEN }}
- Manually trigger the workflow or set it up to run on specific events like pushes or issue comments.
Thank you for using Graph Git Repo! 🚀 Happy visualizing!
REPO_STRUCTURE.md
graph-git-repo
├── .gitignore
├── LICENSE
├── MERMAID_DIAGRAM.md
├── README.md
├── REPO_STRUCTURE.md
├── base.sh
└── tree_to_gpt.py
MERMAID_DIAGRAM.md
graph TD
%% Repository Structure
subgraph graph_git_repo
root[graph-git-repo]
root --> gitignore[.gitignore]
root --> license[LICENSE]
root --> mermaid[MERMAID_DIAGRAM.md]
root --> README[README.md]
root --> repo_structure[REPO_STRUCTURE.md]
root --> base[base.sh]
root --> tree_to_gpt[tree_to_gpt.py]
end
style graph_git_repo fill:#e0f7fa,stroke:#333,stroke-width:2px;
style gitignore fill:#ffccbc,stroke:#333,stroke-width:1px;
style license fill:#ffccbc,stroke:#333,stroke-width:1px;
style mermaid fill:#ffccbc,stroke:#333,stroke-width:1px;
style README fill:#ffccbc,stroke:#333,stroke-width:1px;
style repo_structure fill:#ffccbc,stroke:#333,stroke-width:1px;
style base fill:#ffccbc,stroke:#333,stroke-width:1px;
style tree_to_gpt fill:#ffccbc,stroke:#333,stroke-width:1px;