Skip to content

ci: Init ci#5

Merged
sarathsomana merged 4 commits into
mainfrom
ci/init
May 13, 2026
Merged

ci: Init ci#5
sarathsomana merged 4 commits into
mainfrom
ci/init

Conversation

@sarathsomana

Copy link
Copy Markdown
Owner

Description

This pull request introduces a comprehensive validation and installation system for skill directories, along with improvements to documentation and installation flexibility. The main changes include new scripts and workflows for validating skill structure and frontmatter, enhanced installation options for different AI agents, and updates to documentation to guide contributors and users.

Validation and CI/CD Enhancements:

  • Added a GitHub Actions workflow (.github/workflows/validate-skills.yml) to automatically validate skill YAML frontmatter, directory structure, check for broken links, and lint shell scripts on push and pull request.
  • Introduced a Node.js script (.github/scripts/validate-frontmatter.mjs) to check that each SKILL.md has valid YAML frontmatter, required fields, matching directory names, and proper state definitions.
  • Added a shell script (.github/scripts/validate-structure.sh) to ensure every skill directory contains both SKILL.md and README.md, and that SKILL.md starts with YAML frontmatter.
  • Added a package.json and package-lock.json under .github/scripts to manage dependencies (notably js-yaml) for validation scripts. [1] [2]

Installation Improvements:

  • Updated install.sh to support installation for multiple AI agents, project or global scope, and custom directories, with improved argument parsing and clearer output.
  • Updated installation instructions in README.md to reflect new agent-specific options and supported agents.

Documentation Updates:

  • Enhanced CONTRIBUTING.md to include instructions for running validation checks locally and clarified PR requirements for skill files.
  • Added a .markdownlint.json configuration to customize markdown linting rules.
  • Added a GitHub Actions workflow (.github/workflows/lint-markdown.yml) for markdown linting on relevant files.

Summary of Most Important Changes:

Validation System:

  • Added automated validation scripts and workflows to ensure every skill directory and SKILL.md file meets structural and schema requirements, including frontmatter, required fields, and matching names. [1] [2] [3] [4] [5]

Installation Script Improvements:

  • Enhanced install.sh to support installation for various agents, with options for global/project scope and custom directories, and improved user feedback.

Documentation and Contributor Guidance:

  • Updated CONTRIBUTING.md and README.md to reflect new validation requirements and installation options, making it easier for contributors to comply and for users to install skills. [1] [2]

Markdown Linting:

  • Introduced markdown linting configuration and workflow to enforce documentation standards. [1] [2]

Type of change

  • Bug fix (non-breaking change which fixes an issue)
  • New skill (adds a new skill to the repository)
  • Skill improvement (enhances an existing skill)
  • Documentation update
  • CI

Checklist:

  • I have performed a self-review of my own code/prompts.
  • I have made corresponding changes to the README.md.
  • My changes generate no new warnings or errors in the agent's execution.

- Disable MD022/MD032/MD060/MD026/MD040 rules in .markdownlint.json
  (intentional dense-list style across all 14 skills)
- Fix MD009 (trailing spaces) in CONTRIBUTING, PHILOSOPHY, root-cause-isolator
- Fix MD030 (list-marker spacing) in first-principles-design, skill-architect READMEs
- Fix MD031 (blanks around fences) in INSTALL.md
- Exclude repo's own GitHub/raw URLs from lychee (return 502 while repo is private)
@sarathsomana

Copy link
Copy Markdown
Owner Author

🔧 CI Fix: Markdownlint & Broken Links

Both failing jobs have been addressed:

Markdownlint

  • Config: Disabled rules that conflict with our intentional dense-list style across skills (MD022, MD032, MD060, MD026, MD040)
  • Content fixes: Stripped trailing spaces (MD009), fixed list-marker spacing (MD030), added blank lines before fenced code blocks (MD031)
  • Verified locally: 0 error(s) across all 33 linted files

Broken Links (lychee)

  • Root cause: Lychee was hitting our own repo URLs (github.com/sarathsomana, raw.githubusercontent.com/sarathsomana) which return 502 while the repo is private
  • Fix: Added both URL patterns to the --exclude list in validate-skills.yml

Files changed

.markdownlint.json, validate-skills.yml, CONTRIBUTING.md, INSTALL.md, docs/PHILOSOPHY.md, docs/ROADMAP.md, skills/first-principles-design/README.md, skills/root-cause-isolator/SKILL.md, skills/skill-architect/README.md

@sarathsomana sarathsomana merged commit 5f9d719 into main May 13, 2026
5 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.

1 participant