ashatora/openlayers
1
0
Fork 0
Code Issues Pull Requests Projects Releases Wiki Activity

Clarify that the upgrade-notes.md file should have a header for the current release

Tim Schaub
2016-01-20 09:25:02 -07:00
parent 42a17e7b92
commit 01d8f2998b
1 changed files with 4 additions and 4 deletions
Download Patch File Download Diff File Expand all files Collapse all files
Release-Procedure.md
+4 -4
@@ -17,14 +17,14 @@ Create a changelog for all merges to master since the previous release (see the
Edit the resulting changelog file with any summary notes or special upgrade considerations. Edit the resulting changelog file with any summary notes or special upgrade considerations.
You can extract the upgrade considerations from the [`changelog/upgrade-notes.md`](https://github.com/openlayers/ol3/blob/master/changelog/upgrade-notes.md) file, by looking at the upgrade notes that are not yet assigned to a specific version. You can extract the upgrade considerations from the [`changelog/upgrade-notes.md`](https://github.com/openlayers/ol3/blob/master/changelog/upgrade-notes.md) file, by looking at any upgrade notes since the previous release.
Now edit the [`changelog/upgrade-notes.md`](https://github.com/openlayers/ol3/blob/master/changelog/upgrade-notes.md) to add a new section at head of the file, `### v3.1.0` for example. If the [`changelog/upgrade-notes.md`](https://github.com/openlayers/ol3/blob/master/changelog/upgrade-notes.md)
file does not already have a header for the current release, create a header with the version number (e.g. `### v3.1.0`).
Commit your changes: Commit your changes:
git add changelog/v3.1.0.md git add changelog
git add changelog/upgrade-notes.md
git commit -m 'Changelog for v3.1.0' git commit -m 'Changelog for v3.1.0'
### Update `package.json` ### Update `package.json`