|
84 | 84 | if [ -z "$SKIP_DOCS" ]; then |
85 | 85 | echo -e "\n🔍 Running comprehensive documentation quality checks..." |
86 | 86 |
|
87 | | - # DocC generation with warnings as errors (skip in CI due to permissions issues) |
88 | | - if [ -n "$CI" ]; then |
89 | | - echo "⚠️ Skipping DocC generation in CI environment due to known permissions issues" |
| 87 | + # DocC generation with warnings as errors using Swift package plugin |
| 88 | + echo "Generating DocC documentation using Swift package plugin..." |
| 89 | + docc_output=$(mktemp) |
| 90 | + if ! swift package generate-documentation --warnings-as-errors 2>"$docc_output"; then |
| 91 | + echo "❌ DocC generation failed due to warnings or errors" |
| 92 | + echo "🔍 Error details:" |
| 93 | + while IFS= read -r line; do |
| 94 | + echo " $line" |
| 95 | + done < "$docc_output" |
| 96 | + echo "" |
| 97 | + echo "💡 Common fixes:" |
| 98 | + echo " • Add missing documentation comments (///) to public APIs" |
| 99 | + echo " • Fix broken symbol references in documentation" |
| 100 | + echo " • Resolve conflicting or ambiguous documentation links" |
| 101 | + echo " • Check for invalid markdown syntax in .docc files" |
| 102 | + rm "$docc_output" |
| 103 | + ERRORS=$((ERRORS + 1)) |
90 | 104 | else |
91 | | - echo "Generating DocC documentation (warnings as errors)..." |
92 | | - docc_output=$(mktemp) |
93 | | - if ! swift package generate-documentation --warnings-as-errors 2>"$docc_output"; then |
94 | | - echo "❌ DocC generation failed due to warnings or errors" |
95 | | - echo "🔍 Error details:" |
96 | | - while IFS= read -r line; do |
97 | | - echo " $line" |
98 | | - done < "$docc_output" |
99 | | - echo "" |
100 | | - echo "💡 Common fixes:" |
101 | | - echo " • Add missing documentation comments (///) to public APIs" |
102 | | - echo " • Fix broken symbol references in documentation" |
103 | | - echo " • Resolve conflicting or ambiguous documentation links" |
104 | | - echo " • Check for invalid markdown syntax in .docc files" |
105 | | - rm "$docc_output" |
106 | | - ERRORS=$((ERRORS + 1)) |
107 | | - else |
108 | | - echo "✅ DocC generation successful" |
109 | | - rm "$docc_output" |
110 | | - fi |
| 105 | + echo "✅ DocC generation successful" |
| 106 | + rm "$docc_output" |
111 | 107 | fi |
112 | 108 |
|
113 | 109 | # Full documentation validation suite |
|
0 commit comments