Skip to content
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

Conversation

alan-forbes-cp
Copy link
Collaborator

@alan-forbes-cp alan-forbes-cp commented Nov 8, 2024

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 the setup_build action.
The checkout action version has been standardized at v4.1.0

@alan-forbes-cp 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 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 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
@alan-forbes-cp alan-forbes-cp marked this pull request as ready for review November 11, 2024 17:29
@alan-forbes-cp alan-forbes-cp requested a review from a team as a code owner November 11, 2024 17:29
@alan-forbes-cp alan-forbes-cp merged commit 7ce70e9 into uxlfoundation:main Nov 12, 2024
14 checks passed
@alan-forbes-cp alan-forbes-cp deleted the alan/OR-599_clang_tidy branch November 12, 2024 15:27
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants