CI: add QLdoc test #8365
Merged
CI: add QLdoc test #8365
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
aibaars
force-pushed
the
qldoc-test
branch
4 times, most recently
from
bf3a8b3 to
8147c05
Compare
aibaars
force-pushed
the
qldoc-test
branch
2 times, most recently
from
e1ea69c to
df4696d
Compare
aibaars
force-pushed
the
qldoc-test
branch
2 times, most recently
from
b3e3166 to
6aacc75
Compare
adityasharad
previously approved these changes
Mar 11, 2022
Collaborator
adityasharad
left a comment
adityasharad
left a comment
There was a problem hiding this comment.
Looks sensible! Minor suggestion only.
For now I understand we are only describing undocumented elements. We should discuss further first if we ever plan to render the HTML output of this command.
.github/workflows/check-qldoc.yml
Outdated
| for pack_dir in ${changed_lib_packs}; do | ||
| 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" |
Collaborator
There was a problem hiding this comment.
Minor: You can use ${RUNNER_TEMP} instead of ${{ runner.temp }}, which makes the interpolation a bit less confusing IMO.
Contributor
Author
There was a problem hiding this comment.
ok, done. could you re-approve?
adityasharad
approved these changes
Mar 14, 2022
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
This pull request adds a CI check based on the new
codeql generate library-doc-coveragecommand. It is very similar to the internal test we have, except that it is much faster (30s vs 10m), and adds check annotations to the files. In addition the test output is available to external contributors.Below some links for an example run:
@adityasharad @alexet