-
Notifications
You must be signed in to change notification settings - Fork 34
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Add clang-tidy (changes only) and docs PR jobs #583
Merged
alan-forbes-cp
merged 16 commits into
uxlfoundation:main
from
alan-forbes-cp:alan/OR-599_clang_tidy
Nov 12, 2024
Merged
Add clang-tidy (changes only) and docs PR jobs #583
alan-forbes-cp
merged 16 commits into
uxlfoundation:main
from
alan-forbes-cp:alan/OR-599_clang_tidy
Nov 12, 2024
Conversation
This file contains 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
alan-forbes-cp
changed the title
DRAFT: Add clang-tidy prereqs: checkout, setup, initial build
DRAFT: Add clang-tidy (changes only) and docs jobs
Nov 11, 2024
alan-forbes-cp
changed the title
DRAFT: Add clang-tidy (changes only) and docs jobs
DRAFT: Add clang-tidy (changes only) and docs PR jobs
Nov 11, 2024
alan-forbes-cp
changed the title
DRAFT: Add clang-tidy (changes only) and docs PR jobs
Add clang-tidy (changes only) and docs PR jobs
Nov 11, 2024
coldav
approved these changes
Nov 12, 2024
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
Overview
The original intention was to add both the clang-tidy (changes only) and docs jobs to the PR suite. However a version of the docs job already exists (generating html rather than pdf) and, after discussion, will be retained in its current form with no updates required.
Reason for change
These 2 jobs are the final pair from the original Github PR "priority job" list to be implemented.
Description of change
The clang-tidy job is closely based on Colin's equivalent development job (which in turn is based on the Gitlab version) with minor component version updates.
The clang-tidy PR job has been tested with "fake" clang-tidy issues inserted in 2 files at random. These were identified correctly as "changes only" issues, see test job here: https://github.com/uxlfoundation/oneapi-construction-kit/actions/runs/11780695385/job/32811840927
Similarly, a PR job containing no such issues receives a clean bill of heath.
Anything else we should know?
Installation of
clang-tidy
via pip install has been added in thesetup_build
action.The
checkout
action version has been standardized at v4.1.0