Automated catalog update commit message is formatted incorrectly

[mhutter]

When looking at the commit history for a cluster catalog in GitLab, the commit title is empty (which leads to some usability issues with GitLab).

Steps to Reproduce the Problem

1. check existing catalogs

Actual Behavior

Commit title is empty

Expected Behavior

Commit has a proper title

[mhutter]

My first instinct was that the commit message is not formatted correctly; however investigations showed that the commit messages are formatted correctly.

A test also showed that the issue cannot be reproduced on GitHub, so I assume this is a GitLab issue after all.

I'll try to reproduce the issue

[mhutter]

Related: https://gitlab.com/gitlab-org/gitlab-foss/-/issues/62905
edit migrated issue: https://gitlab.com/gitlab-org/gitlab/-/issues/29315

[mhutter]

The commit message does indeed contain a leading newline:

commodore/commodore/catalog.py

Lines 41 to 51 in 9a498fa

	return f"""
	Automated catalog update from Commodore
	Component commits:
	{component_commits}
	Configuration commits:
	{config_commits}
	Compilation timestamp: {now}
	"""

I assume the git cli and GitHub just trim that away; either during display or during commit. I try to reproduce the issue and report it to GitLab.

[mhutter]

@simu since this will be forever until it is fixed in GitLab, should we in the mean time fix this in commodore?

[srueg]

Nice catch, I tried to find the cause for this issue multiple times as well but wasn't successful! 🎉

[srueg]

I vote for "fixing" this in commodore, PR welcome 😉

[mhutter]

I think this is within my Python knowledge