spring-io / github-changelog-generator

Generates release notes that can be published to GitHub
Apache License 2.0
109 stars 34 forks source link

Allow format issue output text within individual sections and in general #103

Open Dinozavvvr opened 8 months ago

Dinozavvvr commented 8 months ago

Hi everyone! Here is a simple solution for issue #47

wilkinsona commented 8 months ago

Removed generateLinks flag

Even if a custom format allows the links to be omitted, having a flag that controls the behavior when using the default format is a useful convenience that I think should be kept.

Dinozavvvr commented 8 months ago

@wilkinsona Could you describe the scenario of how format should work in the case where it has ${number} but the generateLinks flag is set to false. I suggest another way to eliminate these conflicts by setting the default-format parameter to ${title}, which is equivalent to generateLinks=true.

Another option would be to use generateLinks=true to internally set the default format to ${title}, but not allow generateLinks and default-format to be set at the same time.

Thank you for your feedback, please say me if you have any other ideas

wilkinsona commented 8 months ago

I would only apply generateLinks to the default format and ignore it when a custom format has been supplied.

When using a custom format, I don't think ${number} should generate a link. It should only output the issue's number. If you want a link, I would expect the format to be something like ${title} [${number}](${url}). This should provide complete control over the link and its text. You could then also do something like [${title} ${number}](${url}) if you want the issue's title to be part of the link text.

Dinozavvvr commented 8 months ago

Hi again @wilkinsona. I've put generate-links back the way it worked before. Now, if default-format is explicitly specified, the generate-links flag is ignored. If default-format is not specified, generate-links then "${title}" will be used as the default format, as it worked before. Is it what you wanted?

Dinozavvvr commented 8 months ago

Hi everyone! So what is with this pull request?

snicoll commented 8 months ago

@Dinozavvvr nothing except the team is very busy and has other priorities right now.