|
| 1 | +name: "Check QLdoc coverage" |
| 2 | + |
| 3 | +on: |
| 4 | + pull_request: |
| 5 | + paths: |
| 6 | + - "*/ql/lib/**" |
| 7 | + - .github/workflows/check-qldoc.yml |
| 8 | + branches: |
| 9 | + - main |
| 10 | + - "rc/*" |
| 11 | + |
| 12 | +jobs: |
| 13 | + qldoc: |
| 14 | + runs-on: ubuntu-latest |
| 15 | + |
| 16 | + steps: |
| 17 | + - name: Install CodeQL |
| 18 | + run: | |
| 19 | + gh extension install github/gh-codeql |
| 20 | + gh codeql set-channel nightly |
| 21 | + gh codeql version |
| 22 | + env: |
| 23 | + GITHUB_TOKEN: ${{ github.token }} |
| 24 | + |
| 25 | + - uses: actions/checkout@v3 |
| 26 | + with: |
| 27 | + fetch-depth: 2 |
| 28 | + |
| 29 | + - name: Check QLdoc coverage |
| 30 | + shell: bash |
| 31 | + run: | |
| 32 | + EXIT_CODE=0 |
| 33 | + # TODO: remove the swift exception from the regex when we fix generated QLdoc |
| 34 | + changed_lib_packs="$(git diff --name-only --diff-filter=ACMRT HEAD^ HEAD | { grep -Po '^(?!swift)[a-z]*/ql/lib' || true; } | sort -u)" |
| 35 | + for pack_dir in ${changed_lib_packs}; do |
| 36 | + lang="${pack_dir%/ql/lib}" |
| 37 | + gh codeql generate library-doc-coverage --output="${RUNNER_TEMP}/${lang}-current.txt" --dir="${pack_dir}" |
| 38 | + done |
| 39 | + git checkout HEAD^ |
| 40 | + for pack_dir in ${changed_lib_packs}; do |
| 41 | + # When we add a new language, pack_dir would not exist in HEAD^. |
| 42 | + # In this case the right thing to do is to skip the check. |
| 43 | + [[ ! -d "${pack_dir}" ]] && continue |
| 44 | + lang="${pack_dir%/ql/lib}" |
| 45 | + gh codeql generate library-doc-coverage --output="${RUNNER_TEMP}/${lang}-baseline.txt" --dir="${pack_dir}" |
| 46 | + awk -F, '{gsub(/"/,""); if ($4==0 && $6=="public") print "\""$3"\"" }' "${RUNNER_TEMP}/${lang}-current.txt" | sort -u > "${RUNNER_TEMP}/current-undocumented.txt" |
| 47 | + awk -F, '{gsub(/"/,""); if ($4==0 && $6=="public") print "\""$3"\"" }' "${RUNNER_TEMP}/${lang}-baseline.txt" | sort -u > "${RUNNER_TEMP}/baseline-undocumented.txt" |
| 48 | + UNDOCUMENTED="$(grep -f <(comm -13 "${RUNNER_TEMP}/baseline-undocumented.txt" "${RUNNER_TEMP}/current-undocumented.txt") "${RUNNER_TEMP}/${lang}-current.txt" || true)" |
| 49 | + if [ -n "$UNDOCUMENTED" ]; then |
| 50 | + echo "$UNDOCUMENTED" | awk -F, '{gsub(/"/,""); print "::warning file='"${pack_dir}"'/"$1",line="$2"::Missing QLdoc for "$5, $3 }' |
| 51 | + EXIT_CODE=1 |
| 52 | + fi |
| 53 | + done |
| 54 | + exit "${EXIT_CODE}" |
0 commit comments