Expand docs: trigger modes, check-trigger action, and setup guide#25
Merged
DeDuckProject merged 3 commits intomainfrom Mar 13, 2026
Merged
Expand docs: trigger modes, check-trigger action, and setup guide#25DeDuckProject merged 3 commits intomainfrom
DeDuckProject merged 3 commits intomainfrom
Conversation
- Rewrites README to cover all three trigger modes (auto, on-demand, smart) and the /glimpse comment command with --force and --route flags - Adds check-trigger companion action usage and example workflow - Fixes action reference to DeDuckProject/git-glimpse@v1 - Fixes FFmpeg requirement (not pre-installed on ubuntu-latest) - Adds contents: write permission note (required for asset uploads) - Adds issue_comment event setup for on-demand comment triggers - Adds full configuration reference with all options documented - Removes broken docs/example-comment.png reference (placeholder comment) - Fixes CLAUDE.md repo structure (frameworks/ dir doesn't exist) - Adds CONTRIBUTING.md with setup, test, and PR instructions https://claude.ai/code/session_019RJ9vUJi3QtJ9Sj2PJc9bc
- 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
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
Comprehensive documentation overhaul to cover new trigger modes (
auto,on-demand,smart), thecheck-triggercompanion action for optimizing CI performance, and improved setup instructions. Also adds a newCONTRIBUTING.mdfile for contributors.Key Changes
auto(default),on-demand, andsmartmodes with configuration examples and use cases/glimpse,/glimpse --force, and/glimpse --routePR comment commands with a reference tableissue_commentevent trigger, FFmpeg/Playwright install steps, and proper conditional logic for comment-triggered runstriggersection coveringmode,threshold,include,exclude,commentCommand, andskipCommentoptionscheck-trigger/directory and clarified package purposesgit-glimpse/actiontoDeDuckProject/git-glimpseNotable Details
issue_commenttriggerscheck-triggeroutputs documented with usage examples showing how to conditionally run expensive stepshttps://claude.ai/code/session_019RJ9vUJi3QtJ9Sj2PJc9bc