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 CI workflow for PRs #24

Open
5 tasks
mross-ua opened this issue Jun 15, 2024 · 1 comment
Open
5 tasks

Add CI workflow for PRs #24

mross-ua opened this issue Jun 15, 2024 · 1 comment
Assignees
Labels
enhancement New feature or request question Further information is requested

Comments

@mross-ua
Copy link
Owner

mross-ua commented Jun 15, 2024

We should integrate linter and static analysis tools as a part of PRs.

Some tools that I have seen recommended:

Time allowing, we should explore handling and visibility of compiler warnings.

Tasks

  • Decide which format style should be enforced (use style option)
  • Test functionality with a PR
  • Try adding a linter tool to VS Code that can share configuration with the workflow (note in README)
  • Note in README how coding style is enforced
  • Address "file not found" error for vcpkg or other dependencies (can we ignore these files?)
@mross-ua mross-ua added the enhancement New feature or request label Jun 20, 2024
@mross-ua mross-ua changed the title Add CI for PRs Add CI workflow for PRs Jul 13, 2024
@mross-ua mross-ua self-assigned this Jul 13, 2024
@mross-ua
Copy link
Owner Author

mross-ua commented Jul 13, 2024

I added a preliminary workflow using this recipe which integrates the clang-tidy tool from the LLVM project.

This triggers on PR's and pushes to the main branch (for designated source files). It may scan the entire repo but there are options to limit to only changed lines or files. I expect these and other options will require some tweaking but this issue may be closed when the workflow is "good enough."

@mross-ua mross-ua added the question Further information is requested label Jul 22, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement New feature or request question Further information is requested
Projects
None yet
Development

No branches or pull requests

1 participant