mirror of
https://github.com/github/codeql.git
synced 2025-12-16 16:53:25 +01:00
c63a0e7010
Bumps [actions/checkout](https://github.com/actions/checkout) from 2 to 3. - [Release notes](https://github.com/actions/checkout/releases) - [Changelog](https://github.com/actions/checkout/blob/main/CHANGELOG.md) - [Commits](https://github.com/actions/checkout/compare/v2...v3) --- updated-dependencies: - dependency-name: actions/checkout dependency-type: direct:production update-type: version-update:semver-major ... Signed-off-by: dependabot[bot] <support@github.com>
55 lines
2.2 KiB
YAML
55 lines
2.2 KiB
YAML
name: "Check QLdoc coverage"
|
|
|
|
on:
|
|
pull_request:
|
|
paths:
|
|
- "*/ql/lib/**"
|
|
- .github/workflows/check-qldoc.yml
|
|
branches:
|
|
- main
|
|
- "rc/*"
|
|
|
|
jobs:
|
|
qldoc:
|
|
runs-on: ubuntu-latest
|
|
|
|
steps:
|
|
- name: Install CodeQL
|
|
run: |
|
|
gh extension install github/gh-codeql
|
|
gh codeql set-channel nightly
|
|
gh codeql version
|
|
env:
|
|
GITHUB_TOKEN: ${{ github.token }}
|
|
|
|
- uses: actions/checkout@v3
|
|
with:
|
|
fetch-depth: 2
|
|
|
|
- name: Check QLdoc coverage
|
|
shell: bash
|
|
run: |
|
|
EXIT_CODE=0
|
|
# TODO: remove the swift exception from the regex when we fix generated QLdoc
|
|
changed_lib_packs="$(git diff --name-only --diff-filter=ACMRT HEAD^ HEAD | { grep -Po '^(?!swift)[a-z]*/ql/lib' || true; } | sort -u)"
|
|
for pack_dir in ${changed_lib_packs}; do
|
|
lang="${pack_dir%/ql/lib}"
|
|
gh codeql generate library-doc-coverage --output="${RUNNER_TEMP}/${lang}-current.txt" --dir="${pack_dir}"
|
|
done
|
|
git checkout HEAD^
|
|
for pack_dir in ${changed_lib_packs}; do
|
|
# When we add a new language, pack_dir would not exist in HEAD^.
|
|
# In this case the right thing to do is to skip the check.
|
|
[[ ! -d "${pack_dir}" ]] && continue
|
|
lang="${pack_dir%/ql/lib}"
|
|
gh codeql generate library-doc-coverage --output="${RUNNER_TEMP}/${lang}-baseline.txt" --dir="${pack_dir}"
|
|
awk -F, '{gsub(/"/,""); if ($4==0 && $6=="public") print "\""$3"\"" }' "${RUNNER_TEMP}/${lang}-current.txt" | sort -u > "${RUNNER_TEMP}/current-undocumented.txt"
|
|
awk -F, '{gsub(/"/,""); if ($4==0 && $6=="public") print "\""$3"\"" }' "${RUNNER_TEMP}/${lang}-baseline.txt" | sort -u > "${RUNNER_TEMP}/baseline-undocumented.txt"
|
|
UNDOCUMENTED="$(grep -f <(comm -13 "${RUNNER_TEMP}/baseline-undocumented.txt" "${RUNNER_TEMP}/current-undocumented.txt") "${RUNNER_TEMP}/${lang}-current.txt" || true)"
|
|
if [ -n "$UNDOCUMENTED" ]; then
|
|
echo "$UNDOCUMENTED" | awk -F, '{gsub(/"/,""); print "::warning file='"${pack_dir}"'/"$1",line="$2"::Missing QLdoc for "$5, $3 }'
|
|
EXIT_CODE=1
|
|
fi
|
|
done
|
|
exit "${EXIT_CODE}"
|