search

jmongard / Git.SemVersioning.Gradle

Gradle plugin for automatically versioning a project using semantic versioning and conventional commits with change log support based on git commit messages.
https://plugins.gradle.org/plugin/com.github.jmongard.git-semver-plugin
Apache License 2.0
38 stars 4 forks source link

Having a commit message title with a liternal HTML tag name breaks the release notes layout #48

Closed sschuberth closed 1 week ago

sschuberth commented 5 months ago

Having a commit message like this

`feat(reporter): Use <pre> block for issue messages`

results in release notes being rendered like this

image

because the <pre> is taken literally and being interpreted as a render action.

jmongard commented 4 months ago

I modified the change log formater to add a \ before every <. I hope this solves the issue with html in the texts

sschuberth commented 4 months ago

Confirmed to be fixed with release 0.12.0.

sschuberth commented 4 months ago

I'm reopening this as the implemented escaping is now too eager: Its also escapes < contained in backticks, see e.g. this release:

image

with the original commit title being rendered as

image

and the literal patch including backticks:

image

jmongard commented 4 months ago

It should now support `<html>` and ``<html>`` but not tripple back ticks. I guess it is possible to do the code smarter to handle it but maybe it is not worth the effort.

jmongard commented 2 weeks ago

The plugin should now be able to support any number of `back ticks`