update site - add release instructions - change site deployment directory to ../site
Project: http://git-wip-us.apache.org/repos/asf/incubator-vxquery/repo Commit: http://git-wip-us.apache.org/repos/asf/incubator-vxquery/commit/d9853267 Tree: http://git-wip-us.apache.org/repos/asf/incubator-vxquery/tree/d9853267 Diff: http://git-wip-us.apache.org/repos/asf/incubator-vxquery/diff/d9853267 Branch: refs/heads/master Commit: d9853267df8c7463f3fa5fe00c1697244d1c7071 Parents: 8bcba7b Author: Till Westmann <[email protected]> Authored: Mon Apr 21 22:29:08 2014 -0700 Committer: Till Westmann <[email protected]> Committed: Mon Apr 21 22:29:08 2014 -0700 ---------------------------------------------------------------------- pom.xml | 2 +- src/site/apt/release.apt | 164 ++++++++++++++++++++++++++++++++++++++++++ src/site/site.xml | 1 + 3 files changed, 166 insertions(+), 1 deletion(-) ---------------------------------------------------------------------- http://git-wip-us.apache.org/repos/asf/incubator-vxquery/blob/d9853267/pom.xml ---------------------------------------------------------------------- diff --git a/pom.xml b/pom.xml index b60f3ab..bec5a28 100644 --- a/pom.xml +++ b/pom.xml @@ -198,7 +198,7 @@ <site> <id>vxquery.website</id> <name>VXQuery Website</name> - <url>file:../../site/</url> + <url>file:../site/</url> </site> </distributionManagement> http://git-wip-us.apache.org/repos/asf/incubator-vxquery/blob/d9853267/src/site/apt/release.apt ---------------------------------------------------------------------- diff --git a/src/site/apt/release.apt b/src/site/apt/release.apt new file mode 100644 index 0000000..0ceb907 --- /dev/null +++ b/src/site/apt/release.apt @@ -0,0 +1,164 @@ +~~ Licensed to the Apache Software Foundation (ASF) under one or more +~~ contributor license agreements. See the NOTICE file distributed with +~~ this work for additional information regarding copyright ownership. +~~ The ASF licenses this file to You under the Apache License, Version 2.0 +~~ (the "License"); you may not use this file except in compliance with +~~ the License. You may obtain a copy of the License at +~~ +~~ http://www.apache.org/licenses/LICENSE-2.0 +~~ +~~ Unless required by applicable law or agreed to in writing, software +~~ distributed under the License is distributed on an "AS IS" BASIS, +~~ WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +~~ See the License for the specific language governing permissions and +~~ limitations under the License. + +Releasing Apache VXQuery + +* One time steps + + * add your key to the <<<KEYS>>> file + +--- +(gpg --list-sigs <your name> && gpg2 --armor --export <your name>) >> KEYS +--- + + * check the new <<<KEYS>>> file into the VXQuery distribution directory + +--- +$ svn co https://dist.apache.org/repos/dist/release/incubator/vxquery +$ cd vxquery +$ cp [path to KEYS file] . +$ svn ci -m "add [YOUR NAME]'s key to KEYS file" +--- + + * create an encrypted version of your Apache LDAP password for the nexus repository at {{{https://repository.apache.org/}https://repository.apache.org/}} + + Follow the steps in the {{{http://maven.apache.org/guides/mini/guide-encryption.html}Password Encryption}} + guide to encrypt a master password and to encrypt your Apache LDAP password. + (It's nicer if you have maven > 3.2.1 to do this.) + + * add to <<<~/.m2/settings.xml>>> + + * for the upload to the nexus repository + +--- + <servers> + <!-- To publish a snapshot of some part of Maven --> + <server> + <id>apache.snapshots.https</id> + <username>[YOUR APACHE LDAP USERNAME]</username> + <password>[YOUR APACHE LDAP PASSWORD] (encrypted)</password> + </server> + <!-- To stage a release of some part of Maven --> + <server> + <id>apache.releases.https</id> + <username>[YOUR APACHE LDAP USERNAME]</username> + <password>[YOUR APACHE LDAP PASSWORD] (encrypted)</password> + </server> + ... + </servers> +--- + + * to sign the artifacts + +--- + <profiles> + <profile> + <id>apache-release</id> + <properties> + <gpg.executable>gpg2</gpg.executable> + <gpg.passphrase>...</gpg.passphrase> + </properties> + </profile> + </profiles> +--- + + * Download Apache Rat from {{{https://creadur.apache.org/rat/download_rat.cgi}https://creadur.apache.org/rat/download_rat.cgi}}. + +* Each time steps + + * test your setup + +--- +$ mvn clean install -Papache-release +--- + + * dry run of the release process + +--- +$ mvn release:prepare -DdryRun=true +--- + + * run rat: + +--- +$ java -jar ~/Downloads/apache-rat-0.10/apache-rat-0.10.jar -d . -E .rat-excludes +--- + + * check (and fix) the content of the <<<NOTICE>>> file (especially the date) + + * release to the staging repository + +--- +$ mvn release:prepare +$ mvn release:perform +--- + + * close the staging repository at {{{https://repository.apache.org/}https://repository.apache.org/}} + + * check that the artifacts are available in the repository + + * send out <<<[VOTE]>>> e-mail on vxquery-dev + + * after success on vxquery-dev send out <<<[VOTE]>>> e-mail on [email protected] + + * after successful vote promote staging repository {{{https://repository.apache.org/}https://repository.apache.org/}} + + * add new source artifacts (archive + signature + hashes) to svn {{{https://dist.apache.org/repos/dist/release/incubator/vxquery}https://dist.apache.org/repos/dist/release/incubator/vxquery}} and remove old release dirctory + + * commit changes to svn + + * update the <<<site>>> branch in git from the from the release-tag + + * get site from svn (the site directory needs to be at <<<../site>>> from the git root directory) + +--- +$ cd .. +$ svn co https://svn.apache.org/repos/asf/incubator/vxquery/site +$ cd - +--- + + * build a new site + +--- +$ mvn site site:deploy +--- + + * submit the site to svn + +--- +$ cd ../site +$ svn ci -m"updated site" +$ cd - +--- + + * wait a few days for the mirroring of the release artifacts + + * send <<<[ANNOUNCE]>>> e-mail to [email protected], [email protected], and vxquery-dev + +* References + + * {{{https://docs.sonatype.org/display/Repository/How+To+Generate+PGP+Signatures+With+Maven}How To Generate PGP Signatures With Maven}} + + * {{{https://www.apache.org/dev/publishing-maven-artifacts.html}Publishing Maven Artifacts}} + +~~ * Handling issues +~~ +~~ ** Undo release plugin: +~~ +~~ --- +~~ $ svn merge -r 1526098:1524606 https://svn.apache.org/repos/asf/incubator/vxquery/branches/vxquery_0_2_staging +~~ $ svn del -m "re-releasing build" https://svn.apache.org/repos/asf/incubator/vxquery/tags/apache-vxquery-0.2-incubating +~~ --- + http://git-wip-us.apache.org/repos/asf/incubator-vxquery/blob/d9853267/src/site/site.xml ---------------------------------------------------------------------- diff --git a/src/site/site.xml b/src/site/site.xml index da7924c..daf2f75 100644 --- a/src/site/site.xml +++ b/src/site/site.xml @@ -48,6 +48,7 @@ limitations under the License. <item name="Data Basic Types" href="development_tips.html"/> <item name="Data XML and Node Types" href="development_xml_node_details.html"/> <item name="Eclipse Setup" href="development_eclipse_setup.html"/> + <item name="Release steps" href="release.html"/> </menu> <menu ref="reports"/>
