PointCloudLibrary / PointCloudLibrary/pcl
[CI] Discussion: Adding a linter in the CI pipeline
Nobody has claimed this yet.
- Dominant language
- C++
- Stars
- 11.1k
- Forks
- 4.7k
- Avg merge
- 4d 10h
- Merged PRs (30d)
- 6
Description
Is your feature request related to a problem? Please describe.
Linting issues, which can lead to build-fails, are currently not detected in our CI pipeline.
Context
While extending clang-format to the tracking directory, custom macro formatting gave rise to build errors which was solved by doing a linter check locally: https://github.com/PointCloudLibrary/pcl/pull/3814#issuecomment-616761450
Expected behaviour
A linting check before the formatting begins, and to abort the pipeline in case of errors.
It's lightweight, so there shouldn't be an overhead problem and will save time (early detection).
Current Behavior
No linting. It leads to build-fails which are difficult to debug because they do not indicate syntax issues.
See thread: https://github.com/PointCloudLibrary/pcl/pull/3814#issuecomment-616846356
Contributor guide
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
Start by reading the CI configuration and the discussion linked from PR 3814, especially the clang-format work in the tracking directory. Determine which linter and invocation fit the existing pipeline, then verify that the check runs before formatting and aborts on lint errors.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- cpp
- Domain
- ci-cd, tooling
- Issue type
- Feature
- Difficulty
- 4/5
- Estimated time
- 3-5 days
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 35/100