From 57bf00487d400b9168d582a02c997a09e322c0d6 Mon Sep 17 00:00:00 2001 From: Andreas Hocevar Date: Mon, 13 Feb 2017 13:13:31 +0000 Subject: [PATCH] Add instructions for ol package --- Release-Procedure.md | 26 +++++++++++++++++++++++++- 1 file changed, 25 insertions(+), 1 deletion(-) diff --git a/Release-Procedure.md b/Release-Procedure.md index 2d05423..9fd8612 100644 --- a/Release-Procedure.md +++ b/Release-Procedure.md @@ -46,6 +46,22 @@ E.g. git add package.json git commit -m 'Update package version to 3.1.0' +### Update `package.json` for the ol package + +Update the beta version number in `package/package.json` to reflect the target release. Create a commit for this change as well. + +E.g. +```json +{ + "name": "ol", + "version": "3.1.0-beta.1" +} +``` + + git add package/package.json + git commit -m 'Update ol package version to 3.1.0-beta.1' + + ### Merge the release branch Create a pull request and merge the release branch. This allows for any final review of upgrade notes or other parts of the changelog. @@ -66,6 +82,14 @@ Run the `publish.sh` task with the version number as specified in the `package.j ./tasks/publish.sh 3.1.0 +### Publish the ol package to npm + +Run the make target for creating the package, and publish the package to npm. This implies you have an npm user account which has the correct permissions. + + make package + cd build/package + npm publish + ### Update website You need a local clone of the [openlayers.github.io](https://github.com/openlayers/openlayers.github.io) repo, with the `build` branch checked out. @@ -139,4 +163,4 @@ git cherry-pick Since the `changelog.sh` relies on merge commits, and there won't be any merge commits between the previous release tag and your patch release branch, you'll need to manually create the changelog. Copy one of the existing changelogs for a patch release as a starting point. Link to the pull requests that included the original commits that you cherry picked above. -From this point, you can follow the normal release process ([after the changelog step](https://github.com/openlayers/ol3/wiki/Release-Procedure#update-packagejson)). +From this point, you can follow the normal release process ([after the changelog step](https://github.com/openlayers/ol3/wiki/Release-Procedure#update-packagejson)). \ No newline at end of file