Initial docs on generating a release

2014-04-02 17:41:38 -07:00
parent b4212131b9
commit 438dfe6327
1 changed files with 34 additions and 0 deletions
@@ -0,0 +1,34 @@
+This document is a work in progress.  When it is finalized, it should be included as a doc within the repository itself.
+
+## Release Procedure
+
+### Tag
+
+Tag the release.  In a working copy of the openlayers/ol3 repo:
+
+    # tag the latest from openlayers/master
+    git tag -a v3.0.0-beta.3 -m 'v3.0.0-beta.3'
+
+    # push the tag
+    git push --tags openlayers
+
+### Update website
+
+Edit the `src/pages/index.hbs` page to link to the latest release (this will not be a working link until the release page is added below).
+
+Publish the release artifacts (examples and source) on the website.  In a working copy of the openlayers/openlayers.github.io:
+
+    # with the latest from openlayers/build
+    treeish=v3.0.0-beta.3 npm run deploy
+
+### Create release page and post archive for download
+
+Create an archive from the artifacts created by the `npm run deploy` step above.  This includes the documentation and source.
+
+    # from your working copy of the openlayers/openlayers.github.io repo
+    cd .grunt/openlayers-website/dist/en/
+    zip -r v3.0.0-beta.3.zip v3.0.0-beta.3/
+
+Edit the GitHub release page for the tag (e.g. https://github.com/openlayers/ol3/releases/new?tag=v3.0.0-beta.3) to include a log of changes since the last release.  Description of how to create this log to be added later.
+
+Attach the `.zip` archive created above to the release page.