You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
docs: update README for ack workflow and demo.yml changes from main
- Add separate glimpse-ack.yml workflow snippet (instant 👀 feedback,
separate file to avoid 'skipped' noise on PR push checks)
- Add issues: write permission to workflow examples (required for reactions)
- Add success (🎉) and failure (😕) reactions to comment command flows
- Remove built-in 👀 reaction mention (now handled by ack workflow)
- Expand check-trigger example into full job with all permissions/reactions
- Add note about issue_comment workflows only reading from main branch
https://claude.ai/code/session_019RJ9vUJi3QtJ9Sj2PJc9bc
Two files are recommended. The first is the main pipeline; the second gives instant 👀 feedback on `/glimpse` comments without adding noise to PR push checks.
34
+
35
+
> **Note:** GitHub always reads `issue_comment` workflows from the **default branch** (main). Edits on feature branches are silently ignored for comment triggers — merge to main first for those changes to take effect. Action and core code changes are fine to test on branches.
36
+
37
+
**`.github/workflows/git-glimpse.yml`** — the main pipeline:
32
38
33
39
```yaml
34
-
# .github/workflows/git-glimpse.yml
35
40
name: GitGlimpse
36
41
37
42
on:
38
43
pull_request:
39
44
types: [opened, synchronize]
40
-
issue_comment:# needed for on-demand /glimpse comments
45
+
issue_comment:
41
46
types: [created]
42
47
43
48
jobs:
44
49
demo:
45
50
runs-on: ubuntu-latest
46
-
# Skip issue_comment events that aren't /glimpse on a PR
gh api repos/$GITHUB_REPOSITORY/issues/comments/${{ github.event.comment.id }}/reactions \
98
+
--method POST --field content=confused || true
78
99
```
79
100
101
+
**`.github/workflows/git-glimpse-ack.yml`** — optional but recommended, reacts with 👀 within ~15–30s so the commenter knows their request was received before the heavy pipeline begins:
102
+
103
+
```yaml
104
+
name: GitGlimpse Acknowledge
105
+
106
+
on:
107
+
issue_comment:
108
+
types: [created]
109
+
110
+
jobs:
111
+
ack:
112
+
if: >-
113
+
github.event.issue.pull_request != null &&
114
+
contains(github.event.comment.body, '/glimpse')
115
+
runs-on: ubuntu-latest
116
+
permissions:
117
+
issues: write
118
+
steps:
119
+
- name: React with eyes
120
+
env:
121
+
GH_TOKEN: ${{ secrets.GITHUB_TOKEN }}
122
+
run: |
123
+
gh api repos/$GITHUB_REPOSITORY/issues/comments/${{ github.event.comment.id }}/reactions \
124
+
--method POST --field content=eyes || true
125
+
```
126
+
127
+
The ack workflow is kept separate so it never shows up as a "skipped" check on PR push events — which would add noise for non-developer reviewers.
128
+
80
129
### 2. Add a config file
81
130
82
131
```typescript
@@ -164,9 +213,7 @@ All trigger modes support `/glimpse` PR comments:
164
213
165
214
The command prefix is configurable via `trigger.commentCommand` (default: `/glimpse`).
166
215
167
-
When a `/glimpse` comment is detected, the action acknowledges with a 👀 reaction immediately.
168
-
169
-
> **Note:** The `issue_comment` event must be included in your workflow trigger (as shown in the quick start) for comment commands to work.
216
+
> **Note:** The `issue_comment` event must be included in your workflow trigger (as shown in the quick start) for comment commands to work. Add the optional `git-glimpse-ack.yml` workflow to give commenters immediate 👀 feedback before the heavy pipeline starts.
170
217
171
218
---
172
219
@@ -175,41 +222,71 @@ When a `/glimpse` comment is detected, the action acknowledges with a 👀 react
175
222
Installing FFmpeg and Playwright Chromium takes 2–4 minutes. When using `on-demand` or `smart` mode, many PR pushes would be skipped anyway. The `check-trigger` companion action evaluates the trigger decision first, for the cost of a few seconds, so you can gate the heavy installs on the result.
0 commit comments