superset-showtime 0.2.7__tar.gz → 0.2.8__tar.gz

{superset_showtime-0.2.7 → superset_showtime-0.2.8}/.claude/settings.local.json

@@ -28,7 +28,9 @@
       "Bash(env:*)",
       "Bash(grep:*)",
       "Bash(git grep:*)",
-      "Bash(git push:*)"
+      "Bash(git push:*)",
+      "Bash(make lint:*)",
+      "Bash(mypy:*)"
     ],
     "deny": [],
     "ask": []

{superset_showtime-0.2.7 → superset_showtime-0.2.8}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: superset-showtime
-Version: 0.2.7
+Version: 0.2.8
 Summary: 🎪 Apache Superset ephemeral environment management with circus tent emoji state tracking
 Project-URL: Homepage, https://github.com/apache/superset-showtime
 Project-URL: Documentation, https://superset-showtime.readthedocs.io/

{superset_showtime-0.2.7 → superset_showtime-0.2.8}/showtime/__init__.py

@@ -4,7 +4,7 @@
 Circus tent emoji state tracking for Apache Superset ephemeral environments.
 """
 
-__version__ = "0.2.7"
+__version__ = "0.2.8"
 __author__ = "Maxime Beauchemin"
 __email__ = "maximebeauchemin@gmail.com"
 

superset_showtime-0.2.8/showtime/core/github_messages.py

@@ -0,0 +1,227 @@
+"""
+🎪 GitHub PR comment templates and messaging utilities
+
+Centralized PR comment functions with type hints and clean formatting.
+"""
+
+import os
+import textwrap
+from typing import Dict, List, Optional
+
+from .circus import Show
+
+# AWS Console URL constants
+BASE_AWS_URL = "https://us-west-2.console.aws.amazon.com/ecs/v2/clusters/superset-ci/services"
+AWS_REGION = "us-west-2"
+
+
+def get_github_actor() -> str:
+    """Get current GitHub actor with fallback"""
+    return os.getenv("GITHUB_ACTOR", "unknown")
+
+
+def get_github_workflow_url() -> str:
+    """Get current GitHub Actions workflow URL"""
+    return (
+        os.getenv("GITHUB_SERVER_URL", "https://github.com")
+        + f"/{os.getenv('GITHUB_REPOSITORY', 'repo')}/actions/runs/{os.getenv('GITHUB_RUN_ID', 'run')}"
+    )
+
+
+def get_showtime_footer() -> str:
+    """Get consistent Showtime footer for PR comments"""
+    return "*Powered by [Superset Showtime](https://github.com/mistercrunch/superset-showtime)*"
+
+
+def _create_header_links(sha: str) -> Dict[str, str]:
+    """Create standard header links for comments
+
+    Args:
+        sha: Commit SHA for the environment
+
+    Returns:
+        Dict with showtime_link, gha_link, commit_link
+    """
+    from .circus import short_sha
+
+    repo_path = get_repo_path()
+    return {
+        "showtime_link": "[Showtime](https://github.com/mistercrunch/superset-showtime)",
+        "gha_link": f"[GHA]({get_github_workflow_url()})",
+        "commit_link": f"[{short_sha(sha)}]({get_commit_url(repo_path, sha)})",
+    }
+
+
+def _format_comment(header: str, bullets: List[str]) -> str:
+    """Format comment with header and bullet points
+
+    Args:
+        header: Comment header text
+        bullets: List of bullet point strings (without •)
+    """
+    bullet_text = "\n".join(f"• {bullet}" for bullet in bullets)
+    return textwrap.dedent(
+        f"""
+        {header}
+
+        {bullet_text}
+    """
+    ).strip()
+
+
+def get_commit_url(repo_path: str, sha: str) -> str:
+    """Get GitHub commit URL
+
+    Args:
+        repo_path: Repository path like 'apache/superset'
+        sha: Full or short commit SHA
+    """
+    return f"https://github.com/{repo_path}/commit/{sha}"
+
+
+def get_repo_path() -> str:
+    """Get current repository path from environment"""
+    return os.getenv("GITHUB_REPOSITORY", "apache/superset")
+
+
+def get_aws_console_urls(service_name: str) -> Dict[str, str]:
+    """Get AWS Console URLs for a service"""
+    return {
+        "logs": f"{BASE_AWS_URL}/{service_name}/logs?region={AWS_REGION}",
+        "service": f"{BASE_AWS_URL}/{service_name}?region={AWS_REGION}",
+        "health": f"{BASE_AWS_URL}/{service_name}/health?region={AWS_REGION}",
+    }
+
+
+# Typed comment functions with clear parameter requirements
+
+
+def start_comment(show: Show) -> str:
+    """Create environment start comment
+
+    Args:
+        show: Show object with SHA and other metadata
+    """
+    links = _create_header_links(show.sha)
+    return f"🎪 {links['showtime_link']} is building environment on {links['gha_link']} for {links['commit_link']}"
+
+
+def success_comment(show: Show, feature_count: Optional[int] = None) -> str:
+    """Environment success comment
+
+    Args:
+        show: Show object with SHA, IP, TTL, etc.
+        feature_count: Number of enabled feature flags (optional)
+    """
+    links = _create_header_links(show.sha)
+    header = f"🎪 {links['showtime_link']} deployed environment on {links['gha_link']} for {links['commit_link']}"
+
+    bullets = [
+        f"**Environment:** http://{show.ip}:8080 (admin/admin)",
+        f"**Lifetime:** {show.ttl} auto-cleanup",
+    ]
+
+    if feature_count:
+        bullets.insert(-1, f"**Features:** {feature_count} enabled")
+
+    bullets.append("**Updates:** New commits create fresh environments automatically")
+
+    return _format_comment(header, bullets)
+
+
+def failure_comment(show: Show, error: str) -> str:
+    """Environment failure comment
+
+    Args:
+        show: Show object with SHA and metadata
+        error: Error message describing what went wrong
+    """
+    links = _create_header_links(show.sha)
+    header = f"🎪 {links['showtime_link']} failed building environment on {links['gha_link']} for {links['commit_link']}"
+
+    bullets = [
+        f"**Error:** {error}",
+        "**Action:** Check logs and try again with `🎪 ⚡ showtime-trigger-start`",
+    ]
+
+    return _format_comment(header, bullets)
+
+
+def cleanup_comment(show: Show) -> str:
+    """Environment cleanup comment
+
+    Args:
+        show: Show object with SHA and metadata
+    """
+    links = _create_header_links(show.sha)
+    header = f"🎪 {links['showtime_link']} cleaned up environment on {links['gha_link']} for {links['commit_link']}"
+
+    bullets = [
+        "**Resources:** ECS service and ECR image deleted",
+        "**Cost:** No further charges",
+        "**Action:** Add `🎪 ⚡ showtime-trigger-start` to create new environment",
+    ]
+
+    return _format_comment(header, bullets)
+
+
+def rolling_start_comment(current_show: Show, new_sha: str) -> str:
+    """Rolling update start comment
+
+    Args:
+        current_show: Current Show object with SHA and IP
+        new_sha: New environment SHA (full SHA, will be truncated)
+    """
+    from .circus import short_sha
+
+    links = _create_header_links(new_sha)
+    header = f"🎪 {links['showtime_link']} is updating {current_show.short_sha}→{short_sha(new_sha)} on {links['gha_link']} for {links['commit_link']}"
+
+    bullets = [
+        f"**Current:** http://{current_show.ip}:8080 (still active)",
+        "**Update:** Zero-downtime blue-green deployment",
+    ]
+
+    return _format_comment(header, bullets)
+
+
+def rolling_success_comment(old_show: Show, new_show: Show) -> str:
+    """Rolling update success comment
+
+    Args:
+        old_show: Previous Show object
+        new_show: New Show object with updated IP, SHA, TTL
+    """
+    links = _create_header_links(new_show.sha)
+    header = f"🎪 {links['showtime_link']} updated environment {old_show.short_sha}→{new_show.short_sha} on {links['gha_link']} for {links['commit_link']}"
+
+    bullets = [
+        f"**Environment:** http://{new_show.ip}:8080 (admin/admin)",
+        f"**Lifetime:** {new_show.ttl} auto-cleanup",
+        "**Deployment:** Zero-downtime blue-green",
+        "**Updates:** New commits create fresh environments automatically",
+    ]
+
+    return _format_comment(header, bullets)
+
+
+def rolling_failure_comment(current_show: Show, new_sha: str, error: str) -> str:
+    """Rolling update failure comment
+
+    Args:
+        current_show: Current Show object (still active)
+        new_sha: Failed new environment SHA (full SHA, will be truncated)
+        error: Error message describing what went wrong
+    """
+    from .circus import short_sha
+
+    links = _create_header_links(new_sha)
+    header = f"🎪 {links['showtime_link']} failed updating to {short_sha(new_sha)} on {links['gha_link']} for {links['commit_link']}"
+
+    bullets = [
+        f"**Error:** {error}",
+        f"**Current:** http://{current_show.ip}:8080 (still active)",
+        "**Action:** Check logs and try again with `🎪 ⚡ showtime-trigger-start`",
+    ]
+
+    return _format_comment(header, bullets)

superset_showtime-0.2.7/showtime/core/github_messages.py

@@ -1,198 +0,0 @@
-"""
-🎪 GitHub PR comment templates and messaging utilities
-
-Centralized PR comment functions with type hints and clean formatting.
-"""
-
-import os
-import textwrap
-from typing import Dict, Optional
-
-# AWS Console URL constants
-BASE_AWS_URL = "https://us-west-2.console.aws.amazon.com/ecs/v2/clusters/superset-ci/services"
-AWS_REGION = "us-west-2"
-
-
-def get_github_actor() -> str:
-    """Get current GitHub actor with fallback"""
-    return os.getenv("GITHUB_ACTOR", "unknown")
-
-
-def get_github_workflow_url() -> str:
-    """Get current GitHub Actions workflow URL"""
-    return (
-        os.getenv("GITHUB_SERVER_URL", "https://github.com")
-        + f"/{os.getenv('GITHUB_REPOSITORY', 'repo')}/actions/runs/{os.getenv('GITHUB_RUN_ID', 'run')}"
-    )
-
-
-def get_showtime_footer() -> str:
-    """Get consistent Showtime footer for PR comments"""
-    return "*Powered by [Superset Showtime](https://github.com/mistercrunch/superset-showtime)*"
-
-
-def get_aws_console_urls(service_name: str) -> Dict[str, str]:
-    """Get AWS Console URLs for a service"""
-    return {
-        "logs": f"{BASE_AWS_URL}/{service_name}/logs?region={AWS_REGION}",
-        "service": f"{BASE_AWS_URL}/{service_name}?region={AWS_REGION}",
-        "health": f"{BASE_AWS_URL}/{service_name}/health?region={AWS_REGION}",
-    }
-
-
-# Typed comment functions with clear parameter requirements
-
-
-def start_comment(show) -> str:
-    """Create environment start comment
-
-    Args:
-        show: Show object with SHA and other metadata
-    """
-    return textwrap.dedent(
-        f"""
-        🎪 @{get_github_actor()} Creating ephemeral environment for commit `{show.short_sha}`
-
-        **Action:** [View workflow]({get_github_workflow_url()})
-        **Environment:** `{show.short_sha}`
-        **Powered by:** [Superset Showtime](https://github.com/mistercrunch/superset-showtime)
-
-        *Building and deploying... Watch the labels for progress updates.*
-    """
-    ).strip()
-
-
-def success_comment(show, feature_count: Optional[int] = None) -> str:
-    """Environment success comment
-
-    Args:
-        show: Show object with SHA, IP, TTL, etc.
-        feature_count: Number of enabled feature flags (optional)
-    """
-    feature_line = f"**Feature flags:** {feature_count} enabled\n" if feature_count else ""
-
-    return textwrap.dedent(
-        f"""
-        🎪 @{get_github_actor()} Environment ready at **http://{show.ip}:8080**
-
-        **Environment:** `{show.short_sha}`
-        **Credentials:** admin / admin
-        **TTL:** {show.ttl} (auto-cleanup)
-        {feature_line}
-        **Configuration:** Modify feature flags in your PR code for new SHA
-        **Updates:** Environment updates automatically on new commits
-
-        {get_showtime_footer()}
-    """
-    ).strip()
-
-
-def failure_comment(show, error: str) -> str:
-    """Environment failure comment
-
-    Args:
-        show: Show object with SHA and metadata
-        error: Error message describing what went wrong
-    """
-    return textwrap.dedent(
-        f"""
-        🎪 @{get_github_actor()} Environment creation failed.
-
-        **Error:** {error}
-        **Environment:** `{show.short_sha}`
-
-        Please check the logs and try again.
-
-        {get_showtime_footer()}
-    """
-    ).strip()
-
-
-def cleanup_comment(show) -> str:
-    """Environment cleanup comment
-
-    Args:
-        show: Show object with SHA and metadata
-    """
-    return textwrap.dedent(
-        f"""
-        🎪 @{get_github_actor()} Environment `{show.short_sha}` cleaned up
-
-        **AWS Resources:** ECS service and ECR image deleted
-        **Cost Impact:** No further charges
-
-        Add `🎪 ⚡ showtime-trigger-start` to create a new environment.
-
-        {get_showtime_footer()}
-    """
-    ).strip()
-
-
-def rolling_start_comment(current_show, new_sha: str) -> str:
-    """Rolling update start comment
-
-    Args:
-        current_show: Current Show object with SHA and IP
-        new_sha: New environment SHA (full SHA, will be truncated)
-    """
-    from .circus import short_sha
-
-    return textwrap.dedent(
-        f"""
-        🎪 @{get_github_actor()} Detected new commit - starting rolling update `{current_show.short_sha}` → `{short_sha(new_sha)}`
-
-        **Action:** Zero-downtime blue-green deployment
-        **Progress:** [View workflow]({get_github_workflow_url()})
-        **Current:** `{current_show.short_sha}` at http://{current_show.ip}:8080
-        **New:** `{short_sha(new_sha)}` (building...)
-
-        *New environment will replace current one automatically.*
-    """
-    ).strip()
-
-
-def rolling_success_comment(old_show, new_show) -> str:
-    """Rolling update success comment
-
-    Args:
-        old_show: Previous Show object
-        new_show: New Show object with updated IP, SHA, TTL
-    """
-    return textwrap.dedent(
-        f"""
-        🎪 @{get_github_actor()} Rolling update complete! `{old_show.short_sha}` → `{new_show.short_sha}`
-
-        **New Environment:** **http://{new_show.ip}:8080**
-        **Deployment:** Zero-downtime blue-green deployment
-        **Credentials:** admin / admin
-        **TTL:** {new_show.ttl} (auto-cleanup)
-
-        Your latest changes are now live.
-
-        {get_showtime_footer()}
-    """
-    ).strip()
-
-
-def rolling_failure_comment(current_show, new_sha: str, error: str) -> str:
-    """Rolling update failure comment
-
-    Args:
-        current_show: Current Show object (still active)
-        new_sha: Failed new environment SHA (full SHA, will be truncated)
-        error: Error message describing what went wrong
-    """
-    from .circus import short_sha
-
-    return textwrap.dedent(
-        f"""
-        🎪 @{get_github_actor()} Rolling update failed `{current_show.short_sha}` → `{short_sha(new_sha)}`
-
-        **Error:** {error}
-        **Current:** Environment `{current_show.short_sha}` remains active at http://{current_show.ip}:8080
-
-        Please check the logs and try again with `🎪 ⚡ showtime-trigger-start`.
-
-        {get_showtime_footer()}
-    """
-    ).strip()