Release guide

Here you will find a collection of notes and instructions on doing a release of Apache MetaModel. The page is largely written by Release Engineers (RE) as a note document while conducting releases.

First, some useful links of inspiration to this release guide: 

• General info: http://incubator.apache.org/guides/releasemanagement.html 

• Java release: http://incubator.apache.org/guides/release-java.html 

• Hands-on guide: https://www.apache.org/dev/publishing-maven-artifacts.html 

• Example release guide from another project: http://incubator.apache.org/odftoolkit/odftoolkit-release-guide.html (double check prerequisites)  

NOTE: This page is still in construction

First time release engineers

• You need to have published a public PGP key. 

  • See chapter 'HOW DO YOU UPLOAD A KEY TO A PUBLIC KEY SERVER?' on http://www.apache.org/dev/release-signing.html 

• You need to have added your public key to the MetaModel KEYS file on SVN: https://dist.apache.org/repos/dist/release/metamodel/KEYS

• Set <server> elements in Maven's settings.xml:

<!-- To publish a snapshot of some part of Maven -->
 <server>
     <id>apache.snapshots.https</id>
     <username>APACHE_USERNAME</username>
     <password>APACHE_PASSWORD</password>
 </server>
 <!-- To stage a release of some part of Maven -->
 <server>
     <id>apache.releases.https</id>
     <username>APACHE_USERNAME</username>
     <password>APACHE_PASSWORD</password>
 </server>

Step-by-step guide

1. Check the CHANGES.md file - it should be up to date and it should refer to the version number that you're about to release.
2. Stage a release:
   

   > mvn clean
   > mvn release:prepare -Dusername=APACHE_USERNAME -Dpassword=APACHE_PASSWORD
   > mvn release:perform -Dusername=APACHE_USERNAME -Dpassword=APACHE_PASSWORD

3. Go to nexus (https://repository.apache.org), log in and select the repo. Close it.

4. call for a VOTE in the MetaModel dev@ mailing list. Here's an example email you can use as a template: