Skip to content

Expand docs: trigger modes, check-trigger action, and setup guide#25

Merged
DeDuckProject merged 3 commits intomainfrom
claude/open-source-release-plan-IoaSl
Mar 13, 2026
Merged

Expand docs: trigger modes, check-trigger action, and setup guide#25
DeDuckProject merged 3 commits intomainfrom
claude/open-source-release-plan-IoaSl

Conversation

@DeDuckProject
Copy link
Copy Markdown
Owner

Summary

Comprehensive documentation overhaul to cover new trigger modes (auto, on-demand, smart), the check-trigger companion action for optimizing CI performance, and improved setup instructions. Also adds a new CONTRIBUTING.md file for contributors.

Key Changes

  • Trigger modes documentation: Added detailed sections explaining auto (default), on-demand, and smart modes with configuration examples and use cases
  • Comment commands: Documented /glimpse, /glimpse --force, and /glimpse --route PR comment commands with a reference table
  • check-trigger action: New section showing how to use the lightweight companion action to gate heavy CI steps (FFmpeg, Playwright install) on trigger evaluation, saving 2–4 minutes on skipped runs
  • Improved quick start: Reorganized into numbered steps; added issue_comment event trigger, FFmpeg/Playwright install steps, and proper conditional logic for comment-triggered runs
  • Configuration reference: Expanded with new trigger section covering mode, threshold, include, exclude, commentCommand, and skipComment options
  • CONTRIBUTING.md: New file with setup instructions, repo structure overview, test commands, and PR submission guidelines
  • CLAUDE.md: Updated repo structure to reflect check-trigger/ directory and clarified package purposes
  • Misc improvements: Better formatting with horizontal rules, clarified requirements section, improved route detection explanation, and updated action references from git-glimpse/action to DeDuckProject/git-glimpse

Notable Details

  • Workflow examples now include proper GitHub event filtering for issue_comment triggers
  • check-trigger outputs documented with usage examples showing how to conditionally run expensive steps
  • Configuration examples show all three trigger modes with realistic use cases
  • Removed placeholder image reference and added TODO comment for future screenshot

https://claude.ai/code/session_019RJ9vUJi3QtJ9Sj2PJc9bc

claude added 3 commits March 12, 2026 21:01
- 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
@DeDuckProject DeDuckProject merged commit 45510f3 into main Mar 13, 2026
3 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants