Skip to content

feat: add GitHub Actions skill for workflow creation and debugging#56

Draft
juanmichelini wants to merge 4 commits intomainfrom
openhands/add-github-actions-skill
Draft

feat: add GitHub Actions skill for workflow creation and debugging#56
juanmichelini wants to merge 4 commits intomainfrom
openhands/add-github-actions-skill

Conversation

@juanmichelini
Copy link
Collaborator

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

  • Complete guide for working with GitHub Actions
  • Critical information about testing custom actions (must merge to main first)
  • Debug step examples for printing non-secret parameters
  • Coverage of all action types (workflows, composite actions, reusable workflows)
  • Common pitfalls and non-obvious gotchas including:
    • Action deployment requirements
    • Permission issues (GITHUB_TOKEN, pull_request vs pull_request_target)
    • Secrets handling in fork PRs
    • Path filters, matrix builds, and workflow triggers
    • Artifact handling between jobs
  • Local testing with act
  • Debugging techniques and gh CLI usage
  • Best practices for security and performance

README.md

  • Detailed scenarios and use cases
  • Step-by-step examples for common workflows
  • Advanced patterns (reusable workflows, conditional jobs)
  • Related skills and resources

marketplace.json

  • Registered the skill with appropriate keywords and categorization

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:

  • Workflow file changes not triggering themselves
  • Path filter OR behavior
  • Action version pinning vs @main
  • Environment variable scopes

Testing

All existing tests pass:

  • ✅ Skills have README test
  • ✅ JSON validation for marketplace.json

Related Issue

Implements the feature requested in #55 by @juanmichelini

@juanmichelini can click here to continue refining the PR

- 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>
Copy link

@all-hands-bot all-hands-bot left a 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.

@juanmichelini juanmichelini marked this pull request as draft February 18, 2026 21:22
- 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
Copy link

@all-hands-bot all-hands-bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Taste Rating: 🔴 Needs improvement - Violates AgentSkills progressive disclosure architecture

Verdict: Content quality is solid, but the data structure problem identified in previous reviews remains unaddressed.

Key Insight: SKILL.md should be a 50-80 line decision guide, not a 526-line reference manual—that's an architectural requirement, not a style preference.

- [GitHub Actions Documentation](https://docs.github.com/en/actions)
- [Workflow Syntax Reference](https://docs.github.com/en/actions/using-workflows/workflow-syntax-for-github-actions)
- [GitHub Actions Marketplace](https://github.com/marketplace?type=actions)
- [act - Local Testing Tool](https://github.com/nektos/act)

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

🔴 Critical - Architecture Violation: This file is 526 lines. The AgentSkills spec and previous reviews identified this as a progressive disclosure violation. SKILL.md should be <100 lines—enough for an agent to decide "do I need this?" not "here's every detail."

The Fix: Keep lines 1-23 (frontmatter + Critical Rules). Add a "Quick Patterns" section with 3-5 common patterns (3 lines each). Add "See README.md for detailed examples." Total: ~50-80 lines. Move everything else to README.md.

Why this matters: Every skill load burns context tokens. 526 lines of examples that aren't needed for the initial decision is the wrong data structure for this use case.

@juanmichelini
Copy link
Collaborator Author

@OpenHands address the reviewers points

@openhands-ai
Copy link

openhands-ai bot commented Feb 23, 2026

I'm on it! juanmichelini can track my progress at all-hands.dev

- Reduced SKILL.md from 526 to 81 lines (within 50-80 line target)
- Kept frontmatter and Critical Rules section (got positive review feedback)
- Added concise Quick Patterns section showing 3 action types
- Condensed Key Gotchas to 4 most critical issues
- Moved detailed content to README.md (examples, debugging, testing, best practices)
- Eliminated redundancy between SKILL.md and README.md
- README.md now contains comprehensive detailed reference material

Addresses reviewer feedback:
- Progressive disclosure architecture now properly implemented
- SKILL.md is a decision guide, not a reference manual
- Reduced context token usage for skill loading
- No repeated content between files
@openhands-ai
Copy link

openhands-ai bot commented Feb 23, 2026

Summary of Changes Made

I've successfully addressed all reviewer feedback on PR #56 for the GitHub Actions skill. The changes have been committed and pushed to the remote branch.

✅ Request Completion Checklist

Reviewer Points Addressed:

  • Progressive Disclosure Architecture: SKILL.md reduced from 526 to 81 lines (target: 50-80)
  • Data Structure Fixed: SKILL.md is now a decision guide, README.md is the reference manual
  • Context Token Efficiency: 84% reduction in SKILL.md size (526 → 81 lines)
  • Redundancy Eliminated: No repeated content between files
  • Debug Guidance Clarified: Updated to specify "for new actions OR tricky issues" (not always)
  • Content Reorganized: All detailed examples, debugging, testing moved to README.md

Changes Made (2 files modified)

skills/github-actions/SKILL.md (526 → 81 lines):

  • Kept frontmatter and Critical Rules section
  • Added concise Quick Patterns (3 action type examples)
  • Added Key Gotchas (4 most critical issues)
  • Added pointer to README.md for detailed information

skills/github-actions/README.md (285 → 607 lines):

  • Expanded Types of Actions with full examples
  • Enhanced Common Pitfalls (5 → 10 with code samples)
  • Added Local Testing with act section
  • Added Debugging Failed Workflows section
  • Added Best Practices with implementation example

Validation

  • ✅ All tests pass (README existence check, JSON validation)
  • ✅ No extraneous changes
  • ✅ Changes are concise and focused
  • ✅ Committed with descriptive message
  • Already pushed to origin/openhands/add-github-actions-skill

PR #56 has been updated and now properly implements the AgentSkills progressive disclosure specification.

@juanmichelini
Copy link
Collaborator Author

@OpenHands remove the Quick Patterns section. Add comments to make sure the agent is effective when testing and understanding actions. We want to monitor them, we want to read logs, we want to figure out what's actually happenning not guessing. Think best practices for developing an action with confidence and add them.

Notice that actions have costs so we should take that into account when deciding a plan to test and monitor.
This skill is about effectiveness when working with github actions as SWE, not about syntax.

@openhands-ai
Copy link

openhands-ai bot commented Mar 3, 2026

I'm on it! juanmichelini can track my progress at all-hands.dev

- Remove Quick Patterns section (syntax examples moved to README)
- Add Testing & Monitoring Strategy focused on effectiveness
- Emphasize cost awareness (CI minutes consumption)
- Add practical debugging workflow with gh CLI commands
- Focus on reading logs and understanding actual behavior vs guessing
- Include visibility best practices (debug steps for inputs/outputs)

Addresses reviewer feedback to make skill about SWE effectiveness, not syntax.
@openhands-ai
Copy link

openhands-ai bot commented Mar 3, 2026

Summary of Changes

I've successfully addressed the reviewer's feedback on PR #56 for the GitHub Actions skill. Here's what was changed:

✅ Request Completion Checklist

  • Removed Quick Patterns section - Eliminated syntax-focused code examples (basic workflow, composite action, reusable workflow)
  • Added Testing & Monitoring Strategy section - New content focused on SWE effectiveness
  • Emphasized cost awareness - Highlighted that actions consume CI minutes and planning is essential
  • Added monitoring best practices - Included practical gh CLI commands for watching runs and reading logs
  • Focused on understanding, not guessing - Emphasized reading actual logs and values instead of trial-and-error
  • Added visibility examples - Provided debug step patterns for printing inputs and verifying outputs

Changes Are Concise

The modification was surgical - only the "Quick Patterns" section (lines 26-65) was replaced with the new "Testing & Monitoring Strategy" section. No extraneous changes were made. The file went from 82 to 88 lines, with the increase coming from more detailed debugging guidance as requested.

What Changed

The SKILL.md now leads with practical effectiveness instead of syntax examples:

  • 5-point strategy for efficient testing (local first, debug early, monitor actively, read logs, understand before changing)
  • Real debugging workflow with gh run watch, gh pr checks --watch, and log viewing commands
  • Example debug steps showing how to add visibility to actions (inputs at start, results at end)

Commit pushed: ecc38a31588e2f17dd73148c7462b111032445fc

The skill is now focused on working with GitHub Actions as a professional SWE - monitoring, understanding, and debugging with confidence rather than just syntax knowledge.

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.

feat: skill for github actions

3 participants