-
-
Notifications
You must be signed in to change notification settings - Fork 3.1k
Add upgrade-notes.md file #3296
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
Conversation
@@ -0,0 +1,10 @@ | |||
## Upgrades notes |
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.
Upgrade notes?
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.
Changed. Thanks @bartvde.
This file includes upgrade notes for changes to the library that require changes to application code. This file is used by the release manager to fill the "Upgrade notes" section in the v3.x.y.md changelog file.
Not sure I understand what was decided, but shouldn't there be a heading that states which upgrade path the notes are relevant for? Something like
|
My plan was to accumulate upgrade notes in this file and have the release manager extract the notes that are relevant to his release. |
Sounds good to me. |
This will work for the release manager and anyone who can do a |
The release managers may prepend the release tag (and date?) each time a
release occur. This way changes will be separated by release.
|
Yep! |
Sounds good to me. @elemoine, please merge and update the release procedure doc to add this step. |
Done. |
This file includes upgrade notes for changes to the library that require changes to application code. This file is used by the release manager to fill the "Upgrade notes" section in the v3.x.y.md changelog file.
Ping @ahocevar.