Add a CHANGELOG file for release notes. #29450
Conversation
CHANGELOG-7.x.asciidoc
Outdated
| @@ -0,0 +1,27 @@ | |||
| // Use these for links to issue and pulls. Note issues and pulls redirect one to | |||
| // each other on Github, so don't worry too much on using the right prefix. | |||
| :issue: https://github.com/elastic/elasticsearch/issues/ | |||
There was a problem hiding this comment.
Should these lines be in comments?
CHANGELOG-7.x.asciidoc
Outdated
| :pull: https://github.com/elastic/elasticsearch/pull/ | ||
|
|
||
| //////////////////////////////////////////////////////////// | ||
| // Template, add newest changes here |
There was a problem hiding this comment.
This comments seems to imply changes should be made here, but this is above the actual release notes section?
|
@rjernst made a few changes based on your feedback, thanks! |
CHANGELOG.asciidoc
Outdated
| // Template, add newest changes here | ||
| = Elasticsearch Release Notes | ||
|
|
||
| == Elasticsearch version 7.0.0 |
There was a problem hiding this comment.
maybe just "Elasticsearch 7.0.0"?
|
|
||
| === Regressions | ||
|
|
||
| === Known Issues |
There was a problem hiding this comment.
what would go in the two above sections? I guess this could only be added after the release?
There was a problem hiding this comment.
I added these because we've had them in release notes for 6.0.0. I had assumed that we, at least some of the time, know about regressions and known issues in advance of the release, and choose to ship anyway, that's why I included these. If we don't need them, we can always delete.
CHANGELOG.asciidoc
Outdated
| // :pull: https://github.com/elastic/elasticsearch/pull/ | ||
|
|
||
| //////////////////////////////////////////////////////////// | ||
| // Template, add newest changes here |
There was a problem hiding this comment.
This comment is still confusing, as it implies the changes go here. Also, what is meant by "template"?
There was a problem hiding this comment.
I had left this comment in from the beats template (where I took the header from), I'll revise so it's more clear
pcsanwald
changed the title
|
One more ask: can we put this at the root of the |
rjernst
left a comment
rjernst
left a comment
There was a problem hiding this comment.
LGTM. In order to get elasticsearch-ci passing, I think you need to merge master into your branch, to pickup the bumped 6.2 version.
|
@jpountz you had a few comments which seem resolved, are you ok for me to merge this one? |
|
Yes. |
* Add a CHANGELOG file for 7.x release notes. * update file to include 6.x * remove confusing comment and small edit to section title * moving CHANGELOG file under docs directory, as it pertains to release notes.
|
Pinging @elastic/es-core-infra |
6 participants
In order to improve the quality of our release notes, we're going to start using a CHANGELOG file, one per major release.
The headings in this commit were taken from our previous 6.0 release, as we'll use different headings for minor releases (presumably no breaking changes, etc). I'm happy to, as part of this PR, write a script that populates some of these things in more detail if it's helpful, but I'd also like feedback on the best way to do that; as part of the motivation of this change is to avoid a long list of PRs.