ci-validate-workflow

Validate GitHub Actions workflow files for syntax and best practices.

18|5|Updated Nov 3, 2025
One-click install
npx skills add https://github.com/mvillmow/ml-odyssey --skill ci-validate-workflow
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: ci-validate-workflow
Source: https://github.com/mvillmow/ml-odyssey/tree/main/.claude/skills/ci-validate-workflow
Command: npx skills add https://github.com/mvillmow/ml-odyssey --skill ci-validate-workflow

SYSTEM DOCUMENTATION & REQUIREMENTS

💡 This Skill requires github-cli, actionlint, yamllint.

What problem does it solve? This Skill helps developers validate GitHub Actions workflow files for syntax, best practices, and correctness before committing, preventing broken CI/CD pipelines. It automates early detection of workflow errors, saving debugging time.

Core Features & Use Cases:

  • Syntax Validation: Checks YAML syntax and GitHub Actions specific rules, ensuring valid workflow definitions.
  • Best Practice Enforcement: Guides users to use specific action versions, pin to SHAs, and set timeouts for robust workflows.
  • Use Case: Before pushing a new GitHub Actions workflow, use this skill to validate its syntax and ensure it follows best practices. This catches errors locally instead of waiting for CI to fail, accelerating your CI/CD development.

Quick Start: Use the ci-validate-workflow skill to validate the GitHub Actions workflow file 'build.yml' in the '.github/workflows' directory.

Frequently Asked Questions about ci-validate-workflow

High-intent search queries and answers about installing and using this skill.

FAQPage Schema
How do I validate GitHub Actions workflows before committing?

Validate GitHub Actions workflows using YAML syntax checking and GitHub Actions-specific linting tools to catch syntax errors, invalid action versions, and missing required fields before pushing code. This prevents broken CI/CD pipelines and saves debugging time.

What are the best practices for GitHub Actions workflow files?

Best practices for GitHub Actions workflows include pinning action versions to specific SHAs instead of floating tags, setting timeouts for steps, ensuring runs-on is specified, verifying secrets and variables are available, and confirming all steps reference valid actions.

Can I check GitHub Actions workflows for common errors locally?

Yes, you can check GitHub Actions workflows locally using actionlint and yamllint to detect common issues such as syntax errors, incorrect context usage, missing fields, and invalid action references before CI runs.

Why should I validate workflow YAML before pushing to GitHub?

Validating workflow YAML locally catches configuration errors early, preventing failed CI/CD runs and accelerating development cycles. Early detection saves time compared to discovering errors when GitHub Actions executes the workflow.

Does actionlint support GitHub Actions workflow validation?

Yes, actionlint specializes in validating GitHub Actions workflows for syntax, best practices, and correctness. It checks action versions, step definitions, trigger configurations, and context usage specific to GitHub Actions.

What tools do I need to validate GitHub Actions workflows?

Validate GitHub Actions workflows using gh (GitHub CLI), actionlint for GitHub Actions-specific rules, and yamllint for YAML syntax. These tools together ensure syntax correctness, best practice compliance, and proper workflow structure.