Details
-
Type:
Story
-
Status: Invalid
-
Resolution: Done
-
Fix Version/s: None
-
Component/s: Continuous Integration
-
Labels:
-
Team:SQuaRE
Description
Standards checking should be possible at multiple stages in the development cycle:
1) in the user's local directory without the immediate intent of git-commit;
2) in a pre-commit hook for all branches or, possibly, just the master branch.
When standards checking is invoked, a report on the submitted code will be created and provided to a named file and/or email addresses.
For the pre-commit hook, if the SAT determines that some Rules are serious enough to inhibit a commit, that constraint needs to be incorporated into the git-hook. (The current DM Coding Standards were developed primarily as advisory rules.)
There are nuances which need to be considered for the git-hook:
- should this be done on all branch commits or only the master branch;
- are there any instances where the commit should be aborted.
This has effectively been done thanks to widespread use of Travis/GitHub actions, plus setup.cfg files being available for developers to use their own linters.