-
Notifications
You must be signed in to change notification settings - Fork 13
feat: add GitHub Actions skill for workflow creation and debugging#56
feat: add GitHub Actions skill for workflow creation and debugging #56juanmichelini wants to merge 2 commits intomain from
Conversation
- Add comprehensive GitHub Actions skill with SKILL.md - Include practical examples for testing, debugging, and best practices - Cover common pitfalls like action deployment requirements and permissions - Add README.md with detailed scenarios and use cases - Register skill in marketplace.json Closes #55 Co-authored-by: openhands <openhands@all-hands.dev>
@all-hands-bot
all-hands-bot
left a comment
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Taste Rating: 🟡 Acceptable - Technically solid content but violates progressive disclosure principle.
Verdict: ✅ Worth merging with strong recommendation to refactor for efficiency.
Key Insight: You built a comprehensive reference manual when you needed a concise decision guide. SKILL.md at 530 lines will burn significant context tokens every time an agent loads it—that's the wrong data structure for the progressive disclosure use case.
skills/github-actions/SKILL.md
Outdated
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
🟠 Important - Data Structure Problem: This <IMPORTANT> block appears 4 times in various forms throughout the file (here, line 88, debug sections, etc). You're repeating "merge to main first" and "add debug steps" like it's a mantra.
Why this matters: Repetition suggests your data structure is wrong. These are TWO core rules that should be stated ONCE at the top, then referenced. Instead, they're scattered through 530 lines.
Better approach: Create a "Critical Rules" section at the top with these two principles, then remove the redundant mentions. Cut this file to ~200 lines by moving detailed examples to README.md.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
@OpenHands the review is makign some strong points. Also "3. Debug step: Add a debug step that prints non-secret parameters at the beginning of your action to facilitate troubleshooting" should be done for new actions OR when an issue is particularly tricky to solve, not always.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I'm on it! juanmichelini can track my progress at all-hands.dev
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
🟡 Simplification - Common Pitfalls Bloat: You list 10 "common pitfalls" here. Some are actually the same concept:
- Add public skills from OpenHands repository #1 (merge to main first) and Add Jupyter notebook skill #8 (action versions) are both about stability
- Be explicit about what frontmatter #2 (fork secrets) and Add skill for writing behavior tests #5 (fork secrets again) are duplicates
- Add /releasenotes skill for generating changelogs #6 (workflow changes don't trigger) is a Git behavior, not an Actions pitfall
The problem: This isn't a pitfall list—it's a brain dump. Linus would say: "Good documentation isn't about writing everything you know. It's about writing only what matters."
Pragmatic fix: Keep 4-5 actual gotchas that cause real pain (permissions, secrets, action deployment). Move the rest to README.md examples where they add context, not noise.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
🟠 Important - Progressive Disclosure Violation: This debug example is 15 lines. You have similar examples at line 20, line 360, and in README.md.
Core principle violated: AgentSkills are meant for progressive disclosure—show the agent enough to decide "do I need this skill?" not "here's everything I could ever need to know."
What should happen:
- SKILL.md: "Add a debug step printing non-secret params (see README for examples)"
- README.md: Full examples with context
Why it matters: Every time an agent triggers this skill, you're loading 530 lines into context. That's expensive. Most of the time, the agent needs 100 lines of decision-making info, not 400 lines of copy-paste examples.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
🟡 Pragmatism - Redundancy: This "Action Testing Requirements" section is nearly identical to SKILL.md lines 15-20 and the <IMPORTANT> block.
The question: Is this solving a real problem or creating one? If an agent loads SKILL.md, it already has this context. If a human reads README.md, they get it again. That's not documentation—that's copy-paste.
Better split:
- SKILL.md: Lean decision guide (~150 lines) - "When to use this skill, core rules, quick patterns"
- README.md: Deep examples and scenarios (keep current content) - "How to implement common patterns"
Right now both files are trying to be complete references. Pick your data structure: reference manual OR decision guide. Not both.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
🟢 Good Taste: This pattern (using concurrency to cancel redundant runs) is exactly what good documentation looks like—one clear example with inline comments explaining WHY.
Compare this to the earlier sections with multiple repetitive examples. This is 8 lines of signal vs. hundreds of lines of noise elsewhere. More like this, less like the "10 pitfalls" section.
- Consolidated repetitive content into a single 'Critical Rules' section - Clarified that debug steps should be used for NEW actions OR tricky issues, not always - Removed redundant explanations scattered throughout the document - Updated both SKILL.md and README.md for consistency Addresses feedback from @juanmichelini
Description
This PR adds a comprehensive GitHub Actions skill that helps with creating, testing, and debugging GitHub Actions workflows and custom actions.
Closes #55
What's Included
SKILL.md
actghCLI usageREADME.md
marketplace.json
Key Features
✅ Testing Requirements: Clearly explains the requirement to merge actions to main before use
✅ Debug Guidance: Emphasizes adding debug steps that print non-secret parameters
✅ Practical Examples: Code snippets for real-world scenarios
✅ Security Focus: Covers permissions, secrets, and fork PR handling
✅ Comprehensive Coverage: Addresses tricky, non-obvious issues like:
Testing
All existing tests pass:
Related Issue
Implements the feature requested in #55 by @juanmichelini
@juanmichelini can click here to continue refining the PR