Merge pull request #37 from jnMetaCode/feat/add-agent-lint-ci
Excellent addition! The lint workflow looks solid — validates required frontmatter as errors, recommended sections as warnings, and only lints changed files to avoid noise. Thanks @jnMetaCode!
This commit is contained in:
47
.github/workflows/lint-agents.yml
vendored
Normal file
47
.github/workflows/lint-agents.yml
vendored
Normal file
@@ -0,0 +1,47 @@
|
|||||||
|
name: Lint Agent Files
|
||||||
|
|
||||||
|
on:
|
||||||
|
pull_request:
|
||||||
|
paths:
|
||||||
|
- 'design/**'
|
||||||
|
- 'engineering/**'
|
||||||
|
- 'marketing/**'
|
||||||
|
- 'product/**'
|
||||||
|
- 'project-management/**'
|
||||||
|
- 'testing/**'
|
||||||
|
- 'support/**'
|
||||||
|
- 'spatial-computing/**'
|
||||||
|
- 'specialized/**'
|
||||||
|
- 'strategy/**'
|
||||||
|
|
||||||
|
jobs:
|
||||||
|
lint:
|
||||||
|
name: Validate agent frontmatter and structure
|
||||||
|
runs-on: ubuntu-latest
|
||||||
|
steps:
|
||||||
|
- uses: actions/checkout@v4
|
||||||
|
with:
|
||||||
|
fetch-depth: 0
|
||||||
|
|
||||||
|
- name: Get changed agent files
|
||||||
|
id: changed
|
||||||
|
run: |
|
||||||
|
FILES=$(git diff --name-only --diff-filter=ACMR origin/${{ github.base_ref }}...HEAD -- \
|
||||||
|
'design/*.md' 'engineering/*.md' 'marketing/*.md' 'product/*.md' \
|
||||||
|
'project-management/*.md' 'testing/*.md' 'support/*.md' \
|
||||||
|
'spatial-computing/*.md' 'specialized/*.md' 'strategy/*.md')
|
||||||
|
echo "files=$FILES" >> "$GITHUB_OUTPUT"
|
||||||
|
if [ -z "$FILES" ]; then
|
||||||
|
echo "No agent files changed."
|
||||||
|
else
|
||||||
|
echo "Changed files:"
|
||||||
|
echo "$FILES"
|
||||||
|
fi
|
||||||
|
|
||||||
|
- name: Run agent linter
|
||||||
|
if: steps.changed.outputs.files != ''
|
||||||
|
env:
|
||||||
|
CHANGED_FILES: ${{ steps.changed.outputs.files }}
|
||||||
|
run: |
|
||||||
|
chmod +x scripts/lint-agents.sh
|
||||||
|
./scripts/lint-agents.sh $CHANGED_FILES
|
||||||
115
scripts/lint-agents.sh
Executable file
115
scripts/lint-agents.sh
Executable file
@@ -0,0 +1,115 @@
|
|||||||
|
#!/usr/bin/env bash
|
||||||
|
#
|
||||||
|
# Validates agent markdown files:
|
||||||
|
# 1. YAML frontmatter must exist with name, description, color (ERROR)
|
||||||
|
# 2. Recommended sections checked but only warned (WARN)
|
||||||
|
# 3. File must have meaningful content
|
||||||
|
#
|
||||||
|
# Usage: ./scripts/lint-agents.sh [file ...]
|
||||||
|
# If no files given, scans all agent directories.
|
||||||
|
|
||||||
|
set -euo pipefail
|
||||||
|
|
||||||
|
AGENT_DIRS=(
|
||||||
|
design
|
||||||
|
engineering
|
||||||
|
marketing
|
||||||
|
product
|
||||||
|
project-management
|
||||||
|
testing
|
||||||
|
support
|
||||||
|
spatial-computing
|
||||||
|
specialized
|
||||||
|
strategy
|
||||||
|
)
|
||||||
|
|
||||||
|
REQUIRED_FRONTMATTER=("name" "description" "color")
|
||||||
|
RECOMMENDED_SECTIONS=("Identity" "Core Mission" "Critical Rules")
|
||||||
|
|
||||||
|
errors=0
|
||||||
|
warnings=0
|
||||||
|
|
||||||
|
lint_file() {
|
||||||
|
local file="$1"
|
||||||
|
|
||||||
|
# 1. Check frontmatter delimiters
|
||||||
|
local first_line
|
||||||
|
first_line=$(head -1 "$file")
|
||||||
|
if [[ "$first_line" != "---" ]]; then
|
||||||
|
echo "ERROR $file: missing frontmatter opening ---"
|
||||||
|
errors=$((errors + 1))
|
||||||
|
return
|
||||||
|
fi
|
||||||
|
|
||||||
|
# Extract frontmatter (between first and second ---)
|
||||||
|
local frontmatter
|
||||||
|
frontmatter=$(awk 'NR==1{next} /^---$/{exit} {print}' "$file")
|
||||||
|
|
||||||
|
if [[ -z "$frontmatter" ]]; then
|
||||||
|
echo "ERROR $file: empty or malformed frontmatter"
|
||||||
|
errors=$((errors + 1))
|
||||||
|
return
|
||||||
|
fi
|
||||||
|
|
||||||
|
# 2. Check required frontmatter fields
|
||||||
|
for field in "${REQUIRED_FRONTMATTER[@]}"; do
|
||||||
|
if ! echo "$frontmatter" | grep -qE "^${field}:"; then
|
||||||
|
echo "ERROR $file: missing frontmatter field '${field}'"
|
||||||
|
errors=$((errors + 1))
|
||||||
|
fi
|
||||||
|
done
|
||||||
|
|
||||||
|
# 3. Check recommended sections (warn only)
|
||||||
|
local body
|
||||||
|
body=$(awk 'BEGIN{n=0} /^---$/{n++; next} n>=2{print}' "$file")
|
||||||
|
|
||||||
|
for section in "${RECOMMENDED_SECTIONS[@]}"; do
|
||||||
|
if ! echo "$body" | grep -qi "$section"; then
|
||||||
|
echo "WARN $file: missing recommended section '${section}'"
|
||||||
|
warnings=$((warnings + 1))
|
||||||
|
fi
|
||||||
|
done
|
||||||
|
|
||||||
|
# 4. Check file has meaningful content
|
||||||
|
if [[ $(echo "$body" | wc -w) -lt 50 ]]; then
|
||||||
|
echo "WARN $file: body seems very short (< 50 words)"
|
||||||
|
warnings=$((warnings + 1))
|
||||||
|
fi
|
||||||
|
}
|
||||||
|
|
||||||
|
# Collect files to lint
|
||||||
|
files=()
|
||||||
|
if [[ $# -gt 0 ]]; then
|
||||||
|
files=("$@")
|
||||||
|
else
|
||||||
|
for dir in "${AGENT_DIRS[@]}"; do
|
||||||
|
if [[ -d "$dir" ]]; then
|
||||||
|
while IFS= read -r f; do
|
||||||
|
files+=("$f")
|
||||||
|
done < <(find "$dir" -maxdepth 1 -name "*.md" -type f | sort)
|
||||||
|
fi
|
||||||
|
done
|
||||||
|
fi
|
||||||
|
|
||||||
|
if [[ ${#files[@]} -eq 0 ]]; then
|
||||||
|
echo "No agent files found."
|
||||||
|
exit 1
|
||||||
|
fi
|
||||||
|
|
||||||
|
echo "Linting ${#files[@]} agent files..."
|
||||||
|
echo ""
|
||||||
|
|
||||||
|
for file in "${files[@]}"; do
|
||||||
|
lint_file "$file"
|
||||||
|
done
|
||||||
|
|
||||||
|
echo ""
|
||||||
|
echo "Results: ${errors} error(s), ${warnings} warning(s) in ${#files[@]} files."
|
||||||
|
|
||||||
|
if [[ $errors -gt 0 ]]; then
|
||||||
|
echo "FAILED: fix the errors above before merging."
|
||||||
|
exit 1
|
||||||
|
else
|
||||||
|
echo "PASSED"
|
||||||
|
exit 0
|
||||||
|
fi
|
||||||
Reference in New Issue
Block a user