Conversation
feat: add changelog file generation feature
|
@200Puls, this looks interesting. I'll try to review it this week. Do you have an example of the generated output? |
docs: add changelog usage example
Updated README.MD - now it includes an example of a change log. How do i use the same code format as the project? |
|
|
||
| sections = sections.stream().filter(Objects::nonNull).collect(Collectors.toList()); | ||
|
|
||
| return String.format(CHANGELOG_FORMAT, nextVersion, LocalDate.now(), "\n" + String.join("\n", sections)); |
There was a problem hiding this comment.
I detect that this code is problematic. According to the Bad practice (BAD_PRACTICE), FS: Format string should use %n rather than n (VA_FORMAT_STRING_USES_NEWLINE).
This format string includes a newline character (\n). In format strings, it is generally preferable to use %n, which will produce the platform-specific line separator.
There was a problem hiding this comment.
Hi @lillieMaiBauer, i added a spot bugs plugin to the project.
%n - looks the right thing to do. But i realized this case:
- CI server uses Unix based OS with \n line separator - changelog contains \n as a line separator
- For some reason we decided to perform release from Windows host - which will replace \n to \r\n in the changelog file
I am not sure if this is the correct behavior? I can see in many sources that %n should be used, however - is the case described above ok - so we really want to use platform specific separator in generated changelog file?
fix: add spot bugs plugin
|
@foo4u Hi, any updates on this? |
|
Hello, is there updates on this topic ? This looks interesting |
|
@olpapchenko looks like the project has been abandoned since last year. Perhaps you can go on with a fork and this feature? Great work @foo4u and thanks. |
6 participants
Hi I find your plugin very useful! Thank you very much fo rthe effort.
As I am increasing my usage of conventional commits I'm missing the capability to generate a changelog.
I was about to start implementing this myself when I came across this fork (thanks to @olpapchenko) which adds exactly this missing piece and appears to be very solid.
Would you be open to merge this?