Skip to content

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

Merged
merged 1 commit into from
Mar 3, 2015
Merged

Add upgrade-notes.md file #3296

merged 1 commit into from
Mar 3, 2015

Conversation

elemoine
Copy link
Member

@elemoine elemoine commented Mar 2, 2015

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.

@@ -0,0 +1,10 @@
## Upgrades notes
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Upgrade notes?

Copy link
Member Author

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.
@ahocevar
Copy link
Member

ahocevar commented Mar 2, 2015

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

## v3.3.x

@elemoine
Copy link
Member Author

elemoine commented Mar 2, 2015

My plan was to accumulate upgrade notes in this file and have the release manager extract the notes that are relevant to his release.

@tschaub
Copy link
Member

tschaub commented Mar 2, 2015

Sounds good to me.

@ahocevar
Copy link
Member

ahocevar commented Mar 2, 2015

This will work for the release manager and anyone who can do a git blame, but will look cryptic for anyone else. But if others think that the way it is now is the way to go, I don't mind.

@gberaudo
Copy link
Member

gberaudo commented Mar 3, 2015 via email

@elemoine
Copy link
Member Author

elemoine commented Mar 3, 2015

The release managers may prepend the release tag (and date?) each time a release occur. This way changes will be separated by release.

Yep!

@ahocevar
Copy link
Member

ahocevar commented Mar 3, 2015

Sounds good to me. @elemoine, please merge and update the release procedure doc to add this step.

elemoine pushed a commit that referenced this pull request Mar 3, 2015
Add upgrade-notes.md file
@elemoine elemoine merged commit 787ab91 into openlayers:master Mar 3, 2015
@elemoine elemoine deleted the changes branch March 3, 2015 13:28
@elemoine
Copy link
Member Author

elemoine commented Mar 3, 2015

update the release procedure doc to add this step.

Done.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

5 participants