scripts: compliance: Avoid exception when commit message body is empty #89888
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
Avoid the following exception in the Identity test when the commit body
is empty:
Traceback (most recent call last):
File "zephyr/scripts/ci/check_compliance.py", line 2053, in main
n_fails = _main(args)
^^^^^^^^^^^
File "zephyr/scripts/ci/check_compliance.py", line 1988, in _main
test.run()
File "zephyr/scripts/ci/check_compliance.py", line 1459, in run
auth_name, auth_email, body = git(
^^^^^^^^^^^^^^^^^^^^^^^^^^^
ValueError: not enough values to unpack (expected 3, got 2)
This is triggered because ``%b`` represents the body of the commit
message, which can be empty if there's a single line in it, because the
first line is considered the title.
Signed-off-by: Carles Cufi <carles.cufi@nordicsemi.no>
github-actions
bot
added
area: Coding Guidelines
github-actions
bot
requested review from
fabiobaltieri,
jfischer-no,
kartben,
keith-zephyr,
nashif,
simhein and
stephanosio
carlescufi
force-pushed
the
identity-check-fix
branch
from
49a51d7 to
88f7dfb
Compare
|
|
Do we allow commits with no description? |
With an empty body? no, but we want the script to complain, not to crash. Right now it was crashing with an exception. |
fabiobaltieri
approved these changes
May 13, 2025
pdgendt
approved these changes
May 13, 2025
keith-zephyr
approved these changes
May 15, 2025
kartben
approved these changes
May 15, 2025
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.
Avoid the following exception in the Identity test when the commit body is empty:
This is triggered because
%brepresents the body of the commit message, which can be empty if there's a single line in it, because the first line is considered the title.Tested here: zephyrproject-rtos/zephyr-testing#347