Merge pull request #23 from DeDuckProject/claude/faster-glimpse-emoji-W1aEQ

Add emoji reactions to acknowledge and report command status

Author: DeDuckProject

.github/workflows/demo.yml

@@ -28,6 +28,7 @@ jobs:
     permissions:
       pull-requests: write
       contents: write
+      issues: write
 
     steps:
       - uses: actions/checkout@v4
@@ -99,3 +100,24 @@ jobs:
         env:
           ANTHROPIC_API_KEY: ${{ secrets.ANTHROPIC_API_KEY }}
           GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+
+      - name: React with hooray on success
+        if: >-
+          github.event_name == 'issue_comment' &&
+          steps.check.outputs.should-run == 'true' &&
+          success()
+        env:
+          GH_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+        run: |
+          gh api repos/$GITHUB_REPOSITORY/issues/comments/${{ github.event.comment.id }}/reactions \
+            --method POST --field content=hooray || true
+
+      - name: React with confused on failure
+        if: >-
+          github.event_name == 'issue_comment' &&
+          failure()
+        env:
+          GH_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+        run: |
+          gh api repos/$GITHUB_REPOSITORY/issues/comments/${{ github.event.comment.id }}/reactions \
+            --method POST --field content=confused || true

.github/workflows/glimpse-ack.yml

@@ -0,0 +1,40 @@
+# GitGlimpse Acknowledge Workflow
+#
+# OPTIONAL — this workflow is not required for git-glimpse to work.
+# The demo pipeline runs and posts its comment regardless of whether
+# this file exists.
+#
+# What it does: reacts with 👀 on the /glimpse comment as soon as a
+# runner is available (~15–30s), giving the commenter immediate visual
+# confirmation that their request was received — before the heavy
+# pipeline steps begin.
+#
+# Why it's a separate file: keeping it separate from the main workflow
+# means it never shows up as a "skipped" check on pull_request events.
+# If it were in the same file as the demo job, GitHub would show an
+# "ack (skipped)" entry in the PR checks on every push — noise for
+# non-developer reviewers.
+#
+# ⚠️  Changes only take effect after merging to main (GitHub reads
+#     issue_comment workflows from the default branch).
+name: GitGlimpse Acknowledge
+
+on:
+  issue_comment:
+    types: [created]
+
+jobs:
+  ack:
+    if: >-
+      github.event.issue.pull_request != null &&
+      contains(github.event.comment.body, '/glimpse')
+    runs-on: ubuntu-latest
+    permissions:
+      issues: write
+    steps:
+      - name: React with eyes
+        env:
+          GH_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+        run: |
+          gh api repos/$GITHUB_REPOSITORY/issues/comments/${{ github.event.comment.id }}/reactions \
+            --method POST --field content=eyes || true

CLAUDE.md

@@ -49,6 +49,22 @@ pnpm test --watch   # watch mode
 
 Integration tests require a running app. See `tests/integration/`.
 
+## External-First Design Principle
+
+git-glimpse is used as a GitHub Action (and in future possibly a GitHub App) by *other* repos —
+not just this one. Every change we make must account for the experience of those consumers.
+
+**Rules of thumb:**
+- **Seamless by default**: aim for zero-config or minimal-config integration that just works.
+- **Control when needed**: if seamless isn't achievable (e.g. workflow-level changes), provide
+  clear documentation, sample workflow snippets, and ideally a wrapper action.
+- **No silent breakage**: changes to action inputs/outputs, config schema, or workflow events must
+  be backwards-compatible or clearly versioned.
+- **Test from the outside**: validate features as if you were a consumer repo, not just via this
+  repo's internal `demo.yml`.
+- **Discuss trade-offs**: if a feature requires consumers to make non-trivial changes (new secrets,
+  new workflow jobs, new permissions), flag it in the PR for a deliberate decision.
+
 ## Branching Convention
 
 - Features: `feat/<name>`

packages/action/src/check.ts

@@ -89,6 +89,18 @@ async function check(): Promise<void> {
       return;
     }
 
+    // Acknowledge immediately — this is the earliest action code runs for external users
+    try {
+      await octokit.rest.reactions.createForIssueComment({
+        owner,
+        repo,
+        comment_id: context.payload.comment!.id,
+        content: 'eyes',
+      });
+    } catch {
+      // Non-fatal
+    }
+
     pullNumber = context.payload.issue!.number;
     eventType = 'comment';
 

packages/action/src/index.ts

@@ -76,6 +76,21 @@ async function run(): Promise<void> {
   let headSha: string;
   let eventType: 'push' | 'comment';
   let command = null;
+  let commentId: number | null = null;
+
+  const addCommentReaction = async (content: 'eyes' | 'hooray' | 'confused') => {
+    if (commentId === null) return;
+    try {
+      await octokit.rest.reactions.createForIssueComment({
+        owner,
+        repo,
+        comment_id: commentId,
+        content,
+      });
+    } catch {
+      // Non-fatal
+    }
+  };
 
   if (eventName === 'issue_comment') {
     // Only handle comments on PRs, not plain issues
@@ -92,20 +107,9 @@ async function run(): Promise<void> {
     }
 
     pullNumber = context.payload.issue!.number;
+    commentId = context.payload.comment!.id;
     eventType = 'comment';
 
-    // Acknowledge the command with a reaction
-    try {
-      await octokit.rest.reactions.createForIssueComment({
-        owner,
-        repo,
-        comment_id: context.payload.comment!.id,
-        content: 'eyes',
-      });
-    } catch {
-      // Non-fatal: reaction is best-effort
-    }
-
     // Fetch PR details to get base/head SHAs
     const pr = await octokit.rest.pulls.get({ owner, repo, pull_number: pullNumber });
     baseSha = pr.data.base.sha;
@@ -212,6 +216,10 @@ async function run(): Promise<void> {
     core.info(`Demo comment posted: ${comment.url}`);
     core.setOutput('comment-url', comment.url);
     core.setOutput('success', String(result.success));
+    await addCommentReaction('hooray');
+  } catch (err) {
+    await addCommentReaction('confused');
+    throw err;
   } finally {
     appProcess?.kill();
   }