pre-commit Github action #67
Closed
Conversation
This file contains hidden or 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
* Improve the way to find Enzyme. * Add missing 'REQUIRED' argument to find_library. * Explicitly look for .dylib and .dll in addition to .so. Not providing an extension does not seem to work for Enzyme plugin.
* fixed some style issues and variable name selection * fixed guard for hpp file * fixed typos --------- Co-authored-by: pelesh <[email protected]>
* Defined base classes for Buses and components. * Add infinite bus to phasor dynamic components. * Setup unit testing for phasor dynamics components. * Add simple load component. * Add bus tests. * Add Branch model. * Add load tests. * New Model::Evaluator* * Use override keyword in phasor dynamics models. * Expand code comments.
* Replace ModelEvaluator class. * Remove ModelEvaluatorImpl dependence for power electronics models. * Move power flow specific files to Model/PowerFlow dir. * Add phasor dynamics system composer. * Add test for system composer. * Add template for implementing synchronous machine model. * Add testing framework for the synchronous machine model
* Add dependency-tracking variable data type. * Fix compiler warnings. * Test chain rule with local variable. --------- Co-authored-by: shakedregev <[email protected]>
) * Add preliminary Enzyme support * Use better naming conventions * More verbose tests for enzyme support. * int --> double in Enzyme examples. * Separate scalar and vector examples using Enzyme. * Use classes in EnzymeLibCheck. * Basic usage of DenseMatrix in EnzymeVector example. * Method to convert Dense matriz to COO. * Use DenseMatrix to store the Jacobians in Enzyme vector example. * Working Enzyme derivative of DistributedGenerator * EnzymeLibVectorCheck. * Better documentation of the DenseMatrix class. --------- Co-authored-by: Asher Mancinelli <[email protected]> Co-authored-by: pelesh <[email protected]> Co-authored-by: Slaven Peles <[email protected]>
- Fixed an incorrect option name causing the formatting to not work - Increased column limit to 120 - Moved access modifiers back
this aligns more cloesly with the current codebase, and seems like a good idea since most of the code will be in the `GridKit` namespace
- Short functions will never be on a single line - Don't binpack arguments/parameters - Align pointers and references to the left
- Comments effectively have an extra 80 character column limit from the rest of code (bringing it up to 200 characters) - Comments which are not meant to be written/read in-editor (such as in-documentation Latex or Matlab code, meant to be rendered by other software or copied/pasted directly from/to other software) can start with ** to indicate that they should not be formatted in any way, and clang-format will skip those lines.
This reverts commit 395a5b4.
| @@ -0,0 +1,12 @@ | |||
| repos: | |||
| - repo: https://github.com/pre-commit/mirrors-clang-format | |||
| rev: v19.1.7 | |||
There was a problem hiding this comment.
We should pick a version that we expect people to install with Enzyme, like v15 or so.
| - id: check-toml | ||
| - id: forbid-new-submodules | ||
| - id: end-of-file-fixer | ||
| - id: check-yaml |
There was a problem hiding this comment.
I'm curious - will these check- hooks actually do anything? For instance, if I make a new submodule and then submit a PR will it fail CI or?
There was a problem hiding this comment.
Correct, the check will work as you describe. You can see what it's trying yo do in CI (e.g. https://github.com/ORNL/GridKit/actions/runs/13594004211/job/38006645346#step:4:154). These are mostly legacy checks. We can remove anything we don't need.
|
Closing in favor of #68. |
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.
Setup to apply pre-commit fixes in Github actions.
This is currently set to apply changes automatically when necessary. However, for security reason, this then disables further checks unless using tokens (see https://github.com/EndBug/add-and-commit?tab=readme-ov-file#about-actionscheckout). Adding another commit ourselves should then re-instate checks. There potentially are better ways to handle this.
Another option is to not apply the changes automatically. The pre-commit pipeline will then be reported as failed and it will be on the owner of the pull request to fix it.