[Maintainer doc] Detail expected format of CHANGELOG.md #5103
Conversation
|
Jenkins standing by to test this. If you aren't a maintainer, you can ignore this comment. Someone with commit access, please review this and clear it for Jenkins to run; then say 'jenkins, test it'. |
|
|
||
| ---- | ||
| <1> Latest version is the first line of CHANGELOG.md | ||
| <2> Each version identifier should be a level-1 section title using `##` |
There was a problem hiding this comment.
I though # was header level 1 and ## was header level 2?
There was a problem hiding this comment.
My last read was asciidoctor where they separate document title from section title http://asciidoctor.org/docs/asciidoc-syntax-quick-reference/#section-titles
But in markdown I should indeed say header level-2
|
@elastic/logstash Hey guys, what do you think of this? |
|
@wiibaa Good suggestion, but what about having just 2 tags: |
|
@suyograo As discussed with @ph in #5081 an additional goal could be to simplify (or automate) the creation of the main logstash changelog In recent versions, we can see how it is carefully crafted, so the final presentation of info in this changelog is the driver for the usage of tags upstream. So you decide what you need first, but I see a pattern :). Please see table below
IMHO I do not see a big overhead using tags in the changelog, because they should be derived from the labels used for triage on the github issues. The matter here is to define a sane starting point that bring clear added value. Thinking about the main changelog and giving my 2 cents, I would be tempted to order and group the changes in:
Thoughts ? |
|
@wiibaa Thanks for your explanation. LGTM |
Starting from #5081 reporting CHANGELOG rendering issue on github and after reviewing several CHANGELOG.md in different plugins, I thought that there is room for improvement in harmonizing how the changelog is actually formatted.
@ph please review and discuss with the team, I'm waiting for your green light before looking to other plugins changelog ;)