From 01d8f2998bdc39af9e1e1dbc43855ca1985a602e Mon Sep 17 00:00:00 2001 From: Tim Schaub Date: Wed, 20 Jan 2016 09:25:02 -0700 Subject: [PATCH] Clarify that the `upgrade-notes.md` file should have a header for the current release --- Release-Procedure.md | 8 ++++---- 1 file changed, 4 insertions(+), 4 deletions(-) diff --git a/Release-Procedure.md b/Release-Procedure.md index a9cf33a..50cb181 100644 --- a/Release-Procedure.md +++ b/Release-Procedure.md @@ -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. -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: - git add changelog/v3.1.0.md - git add changelog/upgrade-notes.md + git add changelog git commit -m 'Changelog for v3.1.0' ### Update `package.json`