ci: addition of commit message linter #118
Conversation
Codecov ReportAll modified and coverable lines are covered by tests ✅
Additional details and impacted files@@ Coverage Diff @@
## master #118 +/- ##
======================================
Coverage 5.21% 5.21%
======================================
Files 5 5
Lines 211 211
======================================
Hits 11 11
Misses 200 200 |
tiborsimko
force-pushed
the
commitlint
branch
3 times, most recently
from
c1cd58c
to
27e1fdc
Compare
| @@ -18,7 +42,7 @@ jobs: | |||
| - name: Runs shell script static analysis | |||
| run: | | |||
| sudo apt-get install shellcheck | |||
| ./run-tests.sh --check-shellscript | |||
| ./run-tests.sh --check-shellcheck | |||
There was a problem hiding this comment.
There are some inconsistencies here and in run-tests.sh, as sometimes we call --check-shellcheck and some other times --check-shellscript. For example, in run_all the function check_shellcheck is called, but there is no function with that name.
PS: should we maybe add also a default case in run-tests.sh to catch typos when calling ./run-tests.sh --check-...? Something like this:
for arg in "$@"
do
case $arg in
[...]
*) echo "invalid argument $arg" && exit 2;;
esac
doneThere was a problem hiding this comment.
Wanted to change the command everywhere to have the tool name <-> option name consistency, but apparently forgot some parts. Fixed.
Good idea to do catch-all rule to return error. Added.
run-tests.sh
Outdated
| for arg in "$@" | ||
| do | ||
| case $arg in | ||
| --check-shellscript) check_script;; | ||
| --check-commitlint) check_commitlint "$@";; |
There was a problem hiding this comment.
The passing of $@ to the function breaks when multiple operation are requested, like this:
./run-tests.sh --check-pytest --check-commitlint
Maybe we can remove the for loops that iterates over all the arguments? I personally never pass multiple checks at the same time, so maybe also others do not do that?
There was a problem hiding this comment.
Yes, I'm doing the same as you, so I agree. Changed.
tiborsimko
force-pushed
the
commitlint
branch
from
27e1fdc
to
c6d4780
Compare
Adds commitlint to check the commit message style against agreed conventional commits configuration. Changes script argument values to always use linter names (e.g. shellcheck). Changes argument handling to allow only one checking action that can now accept further optional arguments.
Adds commitlint to check the commit message style against agreed conventional commits configuration. Changes script argument values to always use linter names (e.g. shellcheck). Changes argument handling to allow only one checking action that can now accept further optional arguments.
tiborsimko
force-pushed
the
commitlint
branch
2 times, most recently
from
0c4face
to
7ed5d63
Compare
No description provided.