Allow emoji to be optional

[steven-sheehy]

Emoji icon in release sections would be nice if it was optional in case people wanted a cleaner look and feel for their release notes (like myself).

I've ran ./mvnw verify and previously signed the CLA

[snicoll]

Thanks for the PR. I don't have a strong argument for making the emoji optional and perhaps we should review this altogether.

Rather than having title + emoji and then building the title in the toString we could have a single argument that represents the title and build it upfront. When doing so, we should document that the emoji of a Section is optional rather than silently ignoring it later as you suggest here.

We'd need also to upgrade the tests to cover this scenario.

If you agree, would you be willing to review the PR in that direction?

[steven-sheehy]

Just so I understand, you're advocating removal of the emoji config option and consolidating it into a single title that the user provides, correct? The default section title output would stay the same.

I can do this, I just didn't want to break Spring's tooling or a third party (like release-notes-generator-action) that depends upon the current configuration format and has customized the emoji or title.

When doing so, we should document that the emoji of a Section is optional rather than silently ignoring it later as you suggest here.

With the approach you recommend, it's more appropriate to say that the title accepts, but doesn't require, an emoji in markdown format anywhere in the string, right?

[snicoll]

Just so I understand, you're advocating removal of the emoji config option and consolidating it into a single title that the user provides, correct?

Actually I wasn't but that's a good idea. It would give you the flexibility to format titles any way you like. I am not aware of us using the emoji + title configuration option. Our usage is based on the ReleaseNotesSections that define default sections statically.

it's more appropriate to say that the title accepts, but doesn't require, an emoji in markdown format anywhere in the string, right?

Good idea. We could generalize by saying that the title is in markdown format and that emoji are supported.

[steven-sheehy]

Thanks, I've modified the PR to remove emoji in favor of title containing all necessary information.

[steven-sheehy]

Any update on this?

[philwebb]

Thanks for the PR @steven-sheehy. This is now merged into master.