feat(script): Automatically generate doc_url and severity from ToCs, documentations, and analyser outputs#4225
Merged
dkrupp merged 7 commits intoJan 28, 2025
Conversation
whisperity
added
clang sa 🐉
whisperity
force-pushed
the
refactor/script/label-generator-tooling
branch
from
87ad204 to
9fc110d
Compare
whisperity
added
enhancement 🌟
refactoring 😡 ➡️ 🙂
whisperity
removed
the
RDY-OnHold 🛑
whisperity
force-pushed
the
refactor/script/label-generator-tooling
branch
2 times, most recently
from
2b9363e to
585468d
Compare
whisperity
added
the
label-tool 🔖
Automatically generate the `doc_url` labels for checkers for analysers which we know how to do this. (Currently implemented only for Clang SA and Clang-Tidy.) This tooling does a single HTTP request to download a "Table of Contents" (ToC) document and uses HTML DOM scraping to extract the list of checkers and their corresponding documentation link. There was existing prior work for this feature, but those scripts were about 3 years old (introduced in 2021. Nov, commit aa72dc0), and they ceased to properly work. For example, for _Clang-Tidy_, the contents of the ToC changed in a way that the previously used XPath expression did not match anything at all. In addition, the previous work at `doc_url.py` (later renamed `doc_url_generate.py`) only generated labels for the checkers that were _already_ present in the configuration file, defeating the purpose of using a script to determine new labels for checkers. This version reintroduces an improved DOM scraping logic, and enables generating `doc_url` for checkers that are not yet present in the configuration file, all the while using the new `label_tool/` package structure introduced in a previous commit.
Automatically generate the `severity` labels for checkers of analysers which we know how to. (Currently implemented only for the Clang diagnostic (warning) flags exposed through Clang-Tidy.) There was existing prior work for this feature, but that script was about 3 years old (introduced in 2021. Nov, commit 8d1a7fe), and due to changes in the DOM of Sphinx documents, ceased to work properly since. This refactoring is smaller in scope than the `doc_url` generation that was done in a previous commit, as the original `compiler_warnings.py` script accurately generated severities (and `doc_url`s, for that matter) for previously "unknown" "checkers" as well.
…`severity_generate`
Considering that all previously developed label-generating tools are now subsumed into the new `label_tool` package, the extra directory is unnecessary.
whisperity
force-pushed
the
refactor/script/label-generator-tooling
branch
from
585468d to
716d70e
Compare
After upgrade on `master` to `pylint==3.2.4`, new warnings are enabled which were not honoured in `label-tool`.
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
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.
Important
⛔ Blocked by #4207.
There were some existing scripts in
/scripts/labelswhich generated labels (not justdoc_url, but alsoseverity, in some cases) from analyser-specific knowledge.With the introduction of the
label_toolin the previous patch #4207, it is logical to subsume these scripts to be part of that infrastructure, which is done in this patch.This patch is partially a refactor and partially a fix, as the aforementioned scripts were mostly 3 years old and some ceased to work since, e.g., the generation of labels for Clang-related stuff failed to do anything because the XPath expressions inside were targeting things that are not as such in the current upstream.
The URL generation for Clang SA and Clang-Tidy previously could not do anything with checkers that did not have any labels prior, which is not the case anymore.