| 1 |
--- |
| 2 |
# Copyright (C) 2009-2011 the original author or authors. |
| 3 |
# See the notice.md file distributed with this work for additional |
| 4 |
# information regarding copyright ownership. |
| 5 |
# |
| 6 |
# Licensed under the Apache License, Version 2.0 (the "License"); |
| 7 |
# you may not use this file except in compliance with the License. |
| 8 |
# You may obtain a copy of the License at |
| 9 |
# |
| 10 |
# http://www.apache.org/licenses/LICENSE-2.0 |
| 11 |
# |
| 12 |
# Unless required by applicable law or agreed to in writing, software |
| 13 |
# distributed under the License is distributed on an "AS IS" BASIS, |
| 14 |
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. |
| 15 |
# See the License for the specific language governing permissions and |
| 16 |
# limitations under the License. |
| 17 |
|
| 18 |
title: Release Guide |
| 19 |
in_menu: false |
| 20 |
--- name:overview |
| 21 |
|
| 22 |
# Release Guide |
| 23 |
How to create releases of ${project_name} |
| 24 |
|
| 25 |
--- name:content |
| 26 |
|
| 27 |
## Release Preparation Steps |
| 28 |
|
| 29 |
Various documentation changes first (which should be done before the release is cut) |
| 30 |
|
| 31 |
* edit the **${project_id}-website/ext/Website.scala** file and change the **project\_version** values |
| 32 |
* blog about the release by creating an entry in **${project_id}-website/src/blog/releases** |
| 33 |
* update the changelog.md file, copying and pasting the section the release highlights from the above blog post |
| 34 |
|
| 35 |
## Cutting the release |
| 36 |
|
| 37 |
* prepare the release |
| 38 |
|
| 39 |
{pygmentize:: text} |
| 40 |
mvn -P release release:prepare |
| 41 |
{pygmentize} |
| 42 |
|
| 43 |
* perform the release |
| 44 |
|
| 45 |
{pygmentize:: text} |
| 46 |
mvn -P release release:perform |
| 47 |
{pygmentize} |
| 48 |
|
| 49 |
* open [Nexus Staging](http://repository.apache.org/index.html#staging) |
| 50 |
and close the staged release of #{project_name} |
| 51 |
* now start a vote on the mailing lists and if it passes |
| 52 |
* promote the closed release in nexus |
| 53 |
* announce the release on the [mailing list](index.html) |
| 54 |
* drink beers! |