git-graphable 0.4.0__tar.gz → 0.5.0__tar.gz

{git_graphable-0.4.0 → git_graphable-0.5.0}/.github/workflows/ci.yml

@@ -35,7 +35,7 @@ jobs:
         run: just check
 
       - name: Git Graph Reports
-        uses: ./.github/actions/git-graphable
+        uses: ./
         with:
           production_branch: 'main'
           output_dir: 'git-graph-reports'

git_graphable-0.5.0/.github/workflows/pages.yml

@@ -0,0 +1,46 @@
+name: Deploy Demos to Pages
+
+on:
+  push:
+    branches: [ main ]
+  workflow_dispatch:
+
+permissions:
+  contents: read
+  pages: write
+  id-token: write
+
+jobs:
+  deploy:
+    environment:
+      name: github-pages
+      url: ${{ steps.deployment.outputs.page_url }}
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v4
+        with:
+          fetch-depth: 0
+
+      - name: Setup uv
+        uses: astral-sh/setup-uv@v5
+        with:
+          enable-cache: true
+
+      - name: Install dependencies
+        run: uv sync --all-extras
+
+      - name: Generate Demos
+        run: uv run python examples/publish_demos.py
+
+      - name: Setup Pages
+        uses: actions/configure-pages@v4
+
+      - name: Upload artifact
+        uses: actions/upload-pages-artifact@v3
+        with:
+          path: 'demo-site'
+
+      - name: Deploy to GitHub Pages
+        id: deployment
+        uses: actions/deploy-pages@v4

{git_graphable-0.4.0 → git_graphable-0.5.0}/.gitignore

@@ -131,8 +131,6 @@ cython_debug/
 .DS_Store
 
 # Examples
+demo-site/
 examples/repos/
 examples/assets/
-
-# Temporary test assets
-test_pr.mmd

{git_graphable-0.4.0 → git_graphable-0.5.0}/CHANGELOG.md

@@ -2,6 +2,15 @@
 
 All notable changes to this project will be documented in this file.
 
+## [0.5.0] - 2026-03-06
+
+### Added
+- **Interactive Demos**: Implemented `examples/publish_demos.py` to generate and host live HTML demos via GitHub Pages.
+- **Marketplace Preparation**: Moved `action.yml` to the root directory for GitHub Marketplace publishing and updated related documentation and CI workflows.
+
+### Fixed
+- **Squash Merge Detection**: Resolved a `KeyError` and `CycleError` in the logical merge visualization for squashed pull requests when local branch tips were present.
+
 ## [0.4.0] - 2026-03-05
 
 ### Added

{git_graphable-0.4.0 → git_graphable-0.5.0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: git-graphable
-Version: 0.4.0
+Version: 0.5.0
 Summary: A powerful Git history visualizer and hygiene linter with CI gating.
 Project-URL: Homepage, https://github.com/TheTrueSCU/git-graphable
 Project-URL: Issues, https://github.com/TheTrueSCU/git-graphable/issues
@@ -21,9 +21,13 @@ A powerful Python tool to convert Git commit history into beautiful, interactive
 ## Git Plugin Support
 When installed in your PATH, you can use this as a native Git plugin:
 ```bash
-git graphable .
+git graphable analyze .
 ```
 
+## 🚀 Live Interactive Demo
+Check out the tool in action with our **[Live Interactive Demos](https://thetruescu.github.io/git-graphable/)**. Explore different hygiene scenarios and toggle overlays in real-time.
+
+
 ## Features
 
 - **Multi-Engine Support**: Export to Mermaid (.mmd), D2 (.d2), Graphviz (.dot), or HTML (.html).
@@ -66,6 +70,7 @@ uv run git-graphable init
 
 # Simplify the graph (only show branches/tags)
 uv run git-graphable analyze . --simplify
+```
 
 ## GitHub Action
 
@@ -81,14 +86,37 @@ jobs:
           fetch-depth: 0 # Required to see full history
 
       - name: Generate Git Graph Reports
-        uses: TheTrueSCU/git-graphable/.github/actions/git-graphable@v0.4.0
+        uses: TheTrueSCU/git-graphable@v0.5.0
         with:
           production_branch: 'main'
           output_dir: 'reports'
 ```
 
+### Inputs
+
+The following inputs are available for the `git-graphable` action:
+
+*   **`path`**
+    *   Description: Path to the git repository
+    *   Required: `false`
+    *   Default: `'.'`
+*   **`production_branch`**
+    *   Description: The main production branch (e.g. main, master)
+    *   Required: `false`
+    *   Default: `'main'`
+*   **`issue_engine`**
+    *   Description: Issue tracker engine (github or jira)
+    *   Required: `false`
+*   **`github_token`**
+    *   Description: GitHub token for issue integration
+    *   Required: `false`
+    *   Default: `${{ github.token }}`
+*   **`output_dir`**
+    *   Description: Directory to save the generated reports
+    *   Required: `false`
+    *   Default: `'git-graph-reports'`
+
 The action generates a **simplified Mermaid summary** (for quick review) and a **full interactive HTML graph** (for deep-dive auditing), uploading them as workflow artifacts.
-```
 
 ## Highlighting Options
 

{git_graphable-0.4.0 → git_graphable-0.5.0}/README.md

@@ -5,9 +5,13 @@ A powerful Python tool to convert Git commit history into beautiful, interactive
 ## Git Plugin Support
 When installed in your PATH, you can use this as a native Git plugin:
 ```bash
-git graphable .
+git graphable analyze .
 ```
 
+## 🚀 Live Interactive Demo
+Check out the tool in action with our **[Live Interactive Demos](https://thetruescu.github.io/git-graphable/)**. Explore different hygiene scenarios and toggle overlays in real-time.
+
+
 ## Features
 
 - **Multi-Engine Support**: Export to Mermaid (.mmd), D2 (.d2), Graphviz (.dot), or HTML (.html).
@@ -50,6 +54,7 @@ uv run git-graphable init
 
 # Simplify the graph (only show branches/tags)
 uv run git-graphable analyze . --simplify
+```
 
 ## GitHub Action
 
@@ -65,14 +70,37 @@ jobs:
           fetch-depth: 0 # Required to see full history
 
       - name: Generate Git Graph Reports
-        uses: TheTrueSCU/git-graphable/.github/actions/git-graphable@v0.4.0
+        uses: TheTrueSCU/git-graphable@v0.5.0
         with:
           production_branch: 'main'
           output_dir: 'reports'
 ```
 
+### Inputs
+
+The following inputs are available for the `git-graphable` action:
+
+*   **`path`**
+    *   Description: Path to the git repository
+    *   Required: `false`
+    *   Default: `'.'`
+*   **`production_branch`**
+    *   Description: The main production branch (e.g. main, master)
+    *   Required: `false`
+    *   Default: `'main'`
+*   **`issue_engine`**
+    *   Description: Issue tracker engine (github or jira)
+    *   Required: `false`
+*   **`github_token`**
+    *   Description: GitHub token for issue integration
+    *   Required: `false`
+    *   Default: `${{ github.token }}`
+*   **`output_dir`**
+    *   Description: Directory to save the generated reports
+    *   Required: `false`
+    *   Default: `'git-graph-reports'`
+
 The action generates a **simplified Mermaid summary** (for quick review) and a **full interactive HTML graph** (for deep-dive auditing), uploading them as workflow artifacts.
-```
 
 ## Highlighting Options
 

{git_graphable-0.4.0/.github/actions/git-graphable → git_graphable-0.5.0}/action.yml

@@ -1,9 +1,9 @@
 name: 'Git Graphable'
-description: 'Generate interactive Git hygiene graphs and reports.'
+description: 'Analyze and visualize Git history hygiene with interactive graphs and reports.'
 author: 'TheTrueSCU'
 branding:
-  icon: 'activity'
-  color: 'blue'
+  icon: 'bar-chart'
+  color: 'green'
 
 inputs:
   path:
@@ -38,7 +38,8 @@ runs:
       shell: bash
       run: |
         # Prefer installing local source if we are in the git-graphable repo
-        ROOT_DIR="${{ github.action_path }}/../../.."
+        # github.action_path points to the root in this case
+        ROOT_DIR="${{ github.action_path }}"
         if [ -f "$ROOT_DIR/pyproject.toml" ] && grep -q "name = \"git-graphable\"" "$ROOT_DIR/pyproject.toml"; then
           echo "Installing git-graphable from local source: $ROOT_DIR"
           uv tool install "$ROOT_DIR"

git_graphable-0.5.0/examples/index_template.html

@@ -0,0 +1,24 @@
+<!DOCTYPE html>
+<html>
+<head>
+    <title>Git Graphable Demos</title>
+    <style>
+        body { font-family: sans-serif; line-height: 1.6; max-width: 800px; margin: 40px auto; padding: 0 20px; }
+        h1 { border-bottom: 2px solid #eee; padding-bottom: 10px; }
+        ul { list-style: none; padding: 0; }
+        li { margin-bottom: 10px; background: #f9f9f9; padding: 15px; border-radius: 8px; border: 1px solid #ddd; }
+        a { text-decoration: none; color: #007bff; font-weight: bold; font-size: 1.2em; }
+        a:hover { text-decoration: underline; }
+        .badge { display: inline-block; padding: 2px 8px; background: #eee; border-radius: 4px; font-size: 0.8em; margin-left: 10px; color: #666; }
+    </style>
+</head>
+<body>
+    <h1>Git Graphable Interactive Demos</h1>
+    <p>Select a scenario below to explore the interactive Git hygiene visualization.</p>
+    <ul>
+        $html_links
+    </ul>
+    <hr>
+    <p><a href="https://github.com/TheTrueSCU/git-graphable" style="font-size: 1em;">Back to GitHub Repository</a></p>
+</body>
+</html>

git_graphable-0.5.0/examples/publish_demos.py

@@ -0,0 +1,110 @@
+import shutil
+import subprocess
+from pathlib import Path
+from string import Template
+
+EXAMPLES_DIR = Path(__file__).parent
+REPOS_DIR = EXAMPLES_DIR / "repos"
+OUTPUT_DIR = Path("demo-site")
+
+
+def run_command(cmd):
+    print(f"Running: {' '.join(cmd)}")
+    subprocess.run(cmd, check=True)
+
+
+def main():
+    # 1. Generate the repo data
+    import generate_demos
+
+    generate_demos.main()
+
+    # 2. Prepare output directory
+    if OUTPUT_DIR.exists():
+        shutil.rmtree(OUTPUT_DIR)
+    OUTPUT_DIR.mkdir()
+
+    # 3. Analyze each repo and generate HTML
+    repos = [d for d in REPOS_DIR.iterdir() if d.is_dir()]
+
+    html_links = []
+
+    for repo in sorted(repos):
+        repo_name = repo.name
+        output_file = f"{repo_name}.html"
+        print(f"Analyzing {repo_name}...")
+
+        # Build command with relevant flags for the specific demo
+        cmd = [
+            "uv",
+            "run",
+            "git-graphable",
+            "analyze",
+            "--bare",
+            str(repo),
+            "--engine",
+            "html",
+            "-o",
+            str(OUTPUT_DIR / output_file),
+        ]
+
+        # Add flags based on the demo type
+        if repo_name == "repo-pristine":
+            cmd.extend(["--highlight-authors", "--highlight-critical"])
+        elif repo_name == "repo-messy":
+            cmd.extend(["--highlight-direct-pushes", "--highlight-stale"])
+        elif repo_name == "repo-risk-silo":
+            cmd.extend(["--highlight-silos", "--silo-threshold", "20"])
+        elif repo_name == "repo-complex-hygiene":
+            cmd.extend(["--highlight-back-merges", "--highlight-squashed"])
+        elif repo_name == "repo-features":
+            cmd.extend(["--highlight-orphans", "--highlight-diverging-from", "main"])
+        elif repo_name == "repo-issue-desync":
+            cmd.extend(
+                [
+                    "--highlight-issue-inconsistencies",
+                    "--issue-engine",
+                    "script",
+                    "--issue-script",
+                    "echo CLOSED",
+                ]
+            )
+        elif repo_name == "repo-release-desync":
+            cmd.extend(
+                [
+                    "--highlight-release-inconsistencies",
+                    "--issue-engine",
+                    "script",
+                    "--issue-script",
+                    "echo CLOSED",
+                ]
+            )
+        elif repo_name == "repo-collab-gap":
+            cmd.extend(
+                [
+                    "--highlight-collaboration-gaps",
+                    "--issue-engine",
+                    "script",
+                    "--issue-script",
+                    "echo OPEN,Bob",
+                ]
+            )
+
+        run_command(cmd)
+        label = repo_name.replace("repo-", "").replace("-", " ").title()
+        html_links.append(f'<li><a href="{output_file}">{label}</a></li>')
+
+    # 4. Create index.html from template
+    template_path = EXAMPLES_DIR / "index_template.html"
+    if template_path.exists():
+        template_str = template_path.read_text()
+        t = Template(template_str)
+        index_content = t.substitute(html_links="\n        ".join(html_links))
+        (OUTPUT_DIR / "index.html").write_text(index_content)
+        print(f"\nDone! Demo site generated in {OUTPUT_DIR}/")
+    else:
+        print(f"Error: Template not found at {template_path}")
+
+
+if __name__ == "__main__":
+    main()

{git_graphable-0.4.0 → git_graphable-0.5.0}/pyproject.toml

@@ -28,7 +28,7 @@ keywords = [
 name = "git-graphable"
 readme = "README.md"
 requires-python = ">=3.13"
-version = "0.4.0"
+version = "0.5.0"
 
 [project.optional-dependencies]
 cli = [

{git_graphable-0.4.0 → git_graphable-0.5.0}/src/git_graphable/commands.py

@@ -31,14 +31,28 @@ def handle_output(
 ) -> Optional[str]:
     """Handles exporting and optionally opening the graph. Returns content if output is '-'."""
     if output == "-":
-        # Capture to string
-        import io
-        from contextlib import redirect_stdout
-
-        f = io.StringIO()
-        with redirect_stdout(f):
-            export_graph(graph, "-", config, engine, as_image=False)
-        return f.getvalue()
+        # If output is '-', create a temporary file, export to it,
+        # read its content, and return the content.
+        # This assumes export_graph expects a file path and handles the content.
+        # The 'as_image' flag from the handle_output call is now respected.
+        ext = get_extension(engine, as_image=as_image)
+        with tempfile.NamedTemporaryFile(suffix=ext, delete=False) as tf:
+            temp_path = tf.name
+
+        # Export to the temporary file, respecting the as_image flag
+        export_graph(graph, temp_path, config, engine, as_image=as_image)
+
+        # Read the content of the temporary file
+        mode = "rb" if as_image else "r"
+        encoding = None if as_image else "utf-8"
+
+        with open(temp_path, mode, encoding=encoding) as f:
+            content = f.read()
+
+        # Clean up the temporary file
+        os.remove(temp_path)
+
+        return content
 
     if output:
         # If output path is provided, we use the specified as_image flag or infer from extension

{git_graphable-0.4.0 → git_graphable-0.5.0}/src/git_graphable/highlighter.py

@@ -331,8 +331,12 @@ def _apply_squash_highlights(
                     if is_tip:
                         tips.append(c)
                 for tip in tips:
-                    squash_commit.set_edge_attribute(
-                        tip, Tag.EDGE_LOGICAL_MERGE.value, True
+                    # For squash merges, the 'logical' edge doesn't exist in Git,
+                    # so we must create it in the graph.
+                    # In this graph's convention, child nodes add_dependency(parent).
+                    # The squash commit is the 'new' parent of the old tip.
+                    tip.add_dependency(
+                        squash_commit, **{Tag.EDGE_LOGICAL_MERGE.value: True}
                     )
                     tip.add_tag(Tag.SQUASHED.value)
 

{git_graphable-0.4.0 → git_graphable-0.5.0}/uv.lock

@@ -275,7 +275,7 @@ wheels = [
 
 [[package]]
 name = "git-graphable"
-version = "0.4.0"
+version = "0.5.0"
 source = { editable = "." }
 dependencies = [
     { name = "graphable" },