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.

Sign up for GitHub

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

Jump to bottom

Enable pre-commit for formatting and linting #267

Merged

cwlacewe merged 32 commits into develop from add_precommit

Feb 21, 2025

Contributor

cwlacewe commented Feb 20, 2025 •

edited

Loading

Closes #266

The following were performed in this PR:

Add pre-commit hooks
Applied hooks to repo (Many file changes)
Update CI to include auto-application of pre-commit

Manually modified files:

.clang-format-ignore
.github/CONTRIBUTING.md
.github/scripts/auto-formatter.sh (removed)
.github/workflows/CI.yml
.github/workflows/_CI_coverage.yml
.github/workflows/_CI_update.yml
.github/workflows/_precommit.yml
.pre-commit-config.yaml
client/python/vdms/init.py
README.md

Remaining files were modified after applying hooks

After this is merged, users can manually setup to apply to all commits:

# Initial setup (first-time)
pip install pre-commit
pre-commit install

# Manually check files
pre-commit run --all-files

But as a safe-guard, it is also included in the CI process. In cases where changes are needed, the CI job will fail. If pre-commit can automatically fix issues, the CI will restart with new changes. If pre-commit cannot fix any issues, user should fix requested issues and CI will start once PR is updated.

cwlacewe added 3 commits

February 19, 2025 17:29


          Enable pre-commit (lint, format, line endings, and remove trailing wh…

7d743c4

…itespace) and apply to code


          Merge branch 'develop' into add_precommit

b2484e2


          Remove comments from lint tests

17a53b1

cwlacewe linked an issue

that may be closed by this pull request

Add pre-commit #266

Closed

cwlacewe added 2 commits

February 19, 2025 18:28


          Update workflow and remove formatting

2fc8a21


          Remove auto-formatter.sh as no longer needed

9a9e29b

Contributor

github-actions bot commented Feb 20, 2025

Target CPP Coverage: 64.1421%
Source CPP Coverage: 64.1323%

Target Python Coverage: 98.02%
Source Python Coverage: 97.94%

cwlacewe and others added 20 commits

February 20, 2025 09:18


          Add action to run precommit on pushes

76b16bd


          Insert change that should be fixed by precommit

06cf9f8


          link precommit and CI workflows

62c990f


          Fix inserted issue to run CI

1ef1cdb


          Remove concurrency to see if CI is triggered

efc7272


          try to merge workflows as ci isnt triggering

f222fc2


          Insert change that should be fixed by precommit

aa5124e


          Update CI

1f88a11


          fix trigger

0037fe5


          fix precommit trigger

be69a53


          fix precommit permissions

754ed24


          Fix update trigger

a0cf5cd


          Fix inserted issue

195f099


          Clean workflow scripts

14b77c3


          Insert whitespace to verify CI

9f7f32c


          [pre-commit.ci lite] apply automatic fixes

7413c5c


          Update error message if precommit fails

a498c82


          Covert all code to Google coding style

9abb0f9


          Update push config in workflow

cc58bbf


          clear cache command

ed80aa6

Contributor

github-actions bot commented Feb 20, 2025

Target CPP Coverage: 64.1421%
Source CPP Coverage: 64.1323%

Target Python Coverage: 98.02%
Source Python Coverage: 97.94%

cwlacewe added 2 commits

February 20, 2025 14:21


          Remove comments in update CI and add reference to Developer Guide to …

f22e777

…point to pre-commit instructions


          Remove check push failure workflow

e67fe8d

Contributor

github-actions bot commented Feb 20, 2025

Target CPP Coverage: 64.1421%
Source CPP Coverage: 64.1421%

Target Python Coverage: 98.02%
Source Python Coverage: 97.94%

cwlacewe added 2 commits

February 20, 2025 16:44


          Update commit cmd.

08c4bfe


          fix permission

Contributor

github-actions bot commented Feb 21, 2025

Target CPP Coverage: 64.1421%
Source CPP Coverage: 64.1421%

Target Python Coverage: 98.02%
Source Python Coverage: 97.94%


          Update commit cmd.

bfaafd3

Contributor

github-actions bot commented Feb 21, 2025

Target CPP Coverage: 64.1421%
Source CPP Coverage: 64.1323%

Target Python Coverage: 98.02%
Source Python Coverage: 97.94%


          Remove token from update workflow

383ecb8

Contributor

github-actions bot commented Feb 21, 2025

Target CPP Coverage: 64.1421%
Source CPP Coverage: 64.1421%

Target Python Coverage: 98.02%
Source Python Coverage: 97.94%


          Automated coverage update

5fb63d8

cwlacewe marked this pull request as ready for review

February 21, 2025 08:24

cwlacewe requested review from ifadams and rolandoquesada

February 21, 2025 08:24

Contributor

github-actions bot commented Feb 21, 2025

Target CPP Coverage: 64.1421%
Source CPP Coverage: 64.1421%

Target Python Coverage: 98.02%
Source Python Coverage: 97.94%

rolandoquesada approved these changes

View reviewed changes

Contributor

rolandoquesada left a comment

The changes look good to me.
I like that this format tool also removes unused variables and imported/included libraries.

cwlacewe merged commit cf1f51d into develop

2 checks passed

cwlacewe deleted the add_precommit branch

February 21, 2025 19:15

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet