-
Notifications
You must be signed in to change notification settings - Fork 529
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
[docs] Update Release notes and changelog script #3174
Conversation
Codecov Report
@@ Coverage Diff @@
## master #3174 +/- ##
=======================================
Coverage 78.86% 78.86%
=======================================
Files 106 106
Lines 5589 5589
=======================================
Hits 4408 4408
Misses 1181 1181 |
RELEASES.md
Outdated
* Run the [`check_changelogs.py`](script/check_changelogs.py) script to ensure changelogs are synced across branches. This will soon be a PR check. | ||
* Don't forget to update the "VERSIONS" to include a new branch if necessary. | ||
|
||
* When [beats]() has merged all PRs |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Is this supposed to link somewhere?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
yes! good catch
==== Added | ||
==== Breaking Changes | ||
|
||
[float] | ||
==== Removed | ||
==== Bug fixes | ||
|
||
[float] | ||
==== Bug fixes | ||
==== Intake API Changes | ||
|
||
[float] | ||
==== Added |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
🙌
script/check_changelogs.py
Outdated
|
||
VERSIONS = ["6.0", "6.1", "6.2", "6.3", "6.4", "6.5", "6.6", "6.7", "6.8", "7.0", "7.1", "7.2", "7.3", "7.x"] | ||
|
||
SUPPORTED_VERSIONS = [ "6.8", "7.5", "7.6", "7.x"] |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Nice. This is much easier to update. I noticed we're including 6.8 in the check now, which makes sense as it's a maintained branch. It's showing "failed" when I run the test, because 6.8.6 release notes weren't moved forward. I'll open a new PR to fix that!
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Opened #3191 and backport PRs to fix this.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Thanks for documenting!
Co-Authored-By: Brandon Morelli <[email protected]> Co-Authored-By: Andrew Wilkins <[email protected]>
Update information about necessary steps to take for releases.
@bmorelli25 I think you have been involved in the
check_changelogs.py
script - I updated it within this PR, please review my changes.