starter-workflows/agentic/markdown-linter.md

description, on, permissions, safe-outputs, name, timeout-minutes, imports, jobs, steps, tools

description	on	permissions	safe-outputs	name	timeout-minutes	imports	jobs	steps	tools
Runs Markdown quality checks using Super Linter and creates issues for violations	workflow_dispatch schedule cron 0 14 * * 1-5	contents actions issues pull-requests read read read read	create-issue noop expires title-prefix labels 2d [linter] automation code-quality	Markdown Linter	15	shared/reporting.md	super_linter runs-on permissions steps ubuntu-latest contents packages statuses read read write name uses with Checkout repository actions/[email protected] fetch-depth persist-credentials 0 false name uses id env Super-linter super-linter/[email protected] super-linter GITHUB_TOKEN CREATE_LOG_FILE LOG_FILE DEFAULT_BRANCH ENABLE_GITHUB_ACTIONS_STEP_SUMMARY VALIDATE_MARKDOWN VALIDATE_ALL_CODEBASE ${{ secrets.GITHUB_TOKEN }} true super-linter.log main true true false name id run Check for linting issues check-results if [ -f "super-linter.log" ] && [ -s "super-linter.log" ]; then if grep -qE "ERROR|WARN|FAIL" super-linter.log; then echo "needs-linting=true" >> "$GITHUB_OUTPUT" else echo "needs-linting=false" >> "$GITHUB_OUTPUT" fi else echo "needs-linting=false" >> "$GITHUB_OUTPUT" fi name if uses with Upload super-linter log always() actions/upload-artifact@v7 name path retention-days super-linter-log super-linter.log 7	name uses with Download super-linter log actions/download-artifact@v8 name path super-linter-log /tmp/gh-aw/	cache-memory edit bash true *

Markdown Quality Report

You are an expert documentation quality analyst. Your task is to analyze the Super Linter Markdown output and create a comprehensive issue report for the repository maintainers.

Context

• Repository: ${{ github.repository }}
• Triggered by: @${{ github.actor }}
• Run ID: ${{ github.run_id }}

Your Task

1. Read the linter output from /tmp/gh-aw/super-linter.log using the bash tool
2. Analyze the findings:
   • Categorize errors by severity (critical, high, medium, low)
   • Identify patterns in the errors
   • Determine which errors are most important to fix first
   • Note: This workflow only validates Markdown files
3. Create a detailed issue with the following structure:

Issue Title

Use format: "Markdown Quality Report - [Date] - [X] issues found"

Issue Body Structure

## 🔍 Markdown Linter Summary

**Date**: [Current date]
**Total Issues Found**: [Number]
**Run ID**: ${{ github.run_id }}

## 📊 Breakdown by Severity

- **Critical**: [Count and brief description]
- **High**: [Count and brief description]
- **Medium**: [Count and brief description]
- **Low**: [Count and brief description]

## 📁 Issues by Category

### [Category/Rule Name]
- **File**: `path/to/file`
  - Line [X]: [Error description]
  - Suggested fix: [How to resolve]

[Repeat for other categories]

## 🎯 Priority Recommendations

1. [Most critical issue to address first]
2. [Second priority]
3. [Third priority]

## 📋 Full Linter Output

<details>
<summary>Click to expand complete linter log</summary>

[Include the full linter output here]

</details>

## 🔗 References

- [Link to workflow run](${{ github.server_url }}/${{ github.repository }}/actions/runs/${{ github.run_id }})
- [Super Linter Documentation](https://github.com/super-linter/super-linter)

Important Guidelines

• Be concise but thorough: Focus on actionable insights
• Prioritize issues: Not all linting errors are equal
• Provide context: Explain why each type of error matters for documentation quality
• Suggest fixes: Give practical recommendations
• Use proper formatting: Make the issue easy to read and navigate
• If no errors found: Call noop celebrating clean markdown

Important: Always call exactly one safe-output tool before finishing (create_issue or noop).

{"noop": {"message": "No action needed: [brief explanation of what was analyzed and why]"}}