Repository: mahout Updated Branches: refs/heads/master 182ef0229 -> 2be27b378
NOJIRA: Updating how to release page. Project: http://git-wip-us.apache.org/repos/asf/mahout/repo Commit: http://git-wip-us.apache.org/repos/asf/mahout/commit/2be27b37 Tree: http://git-wip-us.apache.org/repos/asf/mahout/tree/2be27b37 Diff: http://git-wip-us.apache.org/repos/asf/mahout/diff/2be27b37 Branch: refs/heads/master Commit: 2be27b3784412beb907374026cd5e5c787a55eec Parents: 182ef02 Author: Andrew Musselman <[email protected]> Authored: Thu Jul 6 17:11:33 2017 -0700 Committer: Andrew Musselman <[email protected]> Committed: Thu Jul 6 17:11:33 2017 -0700 ---------------------------------------------------------------------- website/oldsite/developers/how-to-release.md | 179 +++++++--------------- 1 file changed, 56 insertions(+), 123 deletions(-) ---------------------------------------------------------------------- http://git-wip-us.apache.org/repos/asf/mahout/blob/2be27b37/website/oldsite/developers/how-to-release.md ---------------------------------------------------------------------- diff --git a/website/oldsite/developers/how-to-release.md b/website/oldsite/developers/how-to-release.md index 30cc13d..adb93be 100644 --- a/website/oldsite/developers/how-to-release.md +++ b/website/oldsite/developers/how-to-release.md @@ -21,11 +21,8 @@ up include: * Any [Resolved or Closed JIRA issues missing a "Fix Version" ](-https://issues.apache.org/jira/secure/issuenavigator!executeadvanced.jspa?jqlquery=project+%3d+mahout+and+%28status+%3d+resolved+or+status+%3d+closed%29+and+fixversion+is+null+and+resolution+%3d+fixed&runquery=true&clear=true.html) that should be marked as fixed in this release? * Does any documentation need an update? - * Who is going to be the "release engineer"? - * What day should be targeted for the release ? Leave buffer time for a -code freeze and release candidate testing; make sure at least a few people -commit to having time to help test the release candidates around the target -date. + * Who is going to be the release engineer? + * What day should be targeted for the release? Leave buffer time for a code freeze and release candidate testing; make sure at least a few people commit to having time to help test the release candidates around the target date. <a name="HowToRelease-CodeFreeze"></a> @@ -45,139 +42,75 @@ warnings) <a name="HowToRelease-Beforebuildingrelease"></a> ## Before building release -1. Check that all tests pass after a clean compile: mvn clean test -1. Check that there are no remaining unresolved Jira issues with the -upcoming version number listed as the "Fix" version -1. Publish any prev. unpublished Third Party Deps: [Thirdparty Dependencies](thirdparty-dependencies.html) - -<a name="HowToRelease-PreviewingtheArtifacts"></a> -## Previewing the Artifacts -1. To build the artifacts: -1. # mvn -Pmahout-release,apache-release,hadoop2 package +1. Check that all tests pass after a clean compile: `mvn clean test` +1. Check that there are no remaining unresolved Jira issues with the upcoming version number listed as the "Fix" version +1. Publish any previously unpublished third-party dependenciess: [Thirdparty Dependencies](thirdparty-dependencies.html) +1. *Confirm whether the viennacl/etc profiles should be in here* Build and preview resulting artifacts: `mvn -Pmahout-release,apache-release,hadoop2 package` <a name="HowToRelease-Makingarelease"></a> ## Making a release * Check if documentation needs an update -* Update the web site's news by updating a working copy of the SVN -directory at https://svn.apache.org/repos/asf/mahout/site/new_website -* Commit these changes. It is important to do this prior to the build so -that it is reflected in the copy of the website included with the release -for documentation purposes. -* If this is your first release, add your key to the KEYS file. The KEYS -file is located on Github at -https://github.com/apache/mahout/master/distribution/KEYS and copy it -to the release directory. -Make sure you commit your change. -See http://www.apache.org/dev/release-signing.html. +* *Needs correction* Update the web site's news by updating a working copy of the SVN directory at https://svn.apache.org/repos/asf/mahout/site/new_website +* *Needs clarification* Commit these changes. It is important to do this prior to the build so that it is reflected in the copy of the website included with the release for documentation purposes. +* If this is your first release, add your key to the KEYS file (located on GitHub at https://github.com/apache/mahout/master/distribution/KEYS) and copy it to the release directory. Make sure you commit your change. See http://www.apache.org/dev/release-signing.html. * Ensure you have set up standard Apache committer settings in ~/.m2/settings.xml as per [this page](http://maven.apache.org/developers/committer-settings.html) . -* Add a profile to your ~/.m2/settings.xml in the <profiles> section with: - - <blockquote> - <profiles> - <profile> - <id>mahout_release</id> - <properties> - <gpg.keyname>YOUR PGP KEY NAME</gpg.keyname> - <gpg.passphrase>YOUR SIGNING PASSCODE HERE</gpg.passphrase> - -<deploy.altRepository>mahout.releases::default::https://repository.apache.org/service/local/staging/deploy/maven2/</deploy.altRepository> - <username>USERNAME</username> - -<deploy.url>https://repository.apache.org/service/local/staging/deploy/maven2/</deploy.url> - </properties> - </profile> - </profiles> -</blockquote> - -* You may also need to add the following to the <servers> section in -~/.m2/settings.xml in order to upload artifacts (as the -Dusername= --Dpassword= didn't work for Grant for 0.8, but this did): -<blockquote> +* Add a profile to your `~/.m2/settings.xml` in the `<profiles>` section with: + +``` +<profiles> + <profile> + <id>mahout_release</id> + <properties> + <gpg.keyname>1234BEEF</gpg.keyname> + <gpg.passphrase>YOUR_SIGNING_PASSCODE_HERE</gpg.passphrase> + <deploy.altRepository>mahout.releases::default::https://repository.apache.org/service/local/staging/deploy/maven2/</deploy.altRepository> + <username>USERNAME</username> + <deploy.url>https://repository.apache.org/service/local/staging/deploy/maven2/</deploy.url> + </properties> + </profile> +</profiles> +``` + +* You may also need to add the following to the `<servers>` section in `~/.m2/settings.xml` in order to upload artifacts (as the `-Dusername=` `-Dpassword=` didn't work for gsingers for 0.8, but this did; n.b. it didn't work for akm for the 0.13 release): +``` <server> <id>apache.releases.https</id> <username>USERNAME</username> <password>PASSWORD</password> </server> -</blockquote> - -* Set environment variable MAVEN_OPTS to -Xmx1024m to ensure the tests can -run -* export _JAVA_OPTIONS="-Xmx1g" -* If you are outside the US, then svn.apache.org may not resolve to the -main US-based Subversion servers. (Compare the IP address you get for -svn.apache.org with svn.us.apache.org to see if they are different.) This -will cause problems during the release since it will create a revision and -then immediately access, but, there is a replication lag of perhaps a -minute to the non-US servers. To temporarily force using the US-based -server, edit your equivalent of /etc/hosts and map the IP address of -svn.us.apache.org to svn.apache.org. -* Create the release candidate: - - mvn -Pmahout-release,apache-release,hadoop2 release:prepare release:perform - - If you have problems authenticating to svn.apache.org, try adding to the command line - - -Dusername=\[user]\ -Dpassword=\[password\] - - If it screws up, first try doing: - - mvn -Dmahout-release,apache-release,hadoop2 release:rollback. - - followed by - - mvn -Dmahout-release,apache-release,hadoop2 release:clean - - This will likely save you time and do the right thing. - - You may also have to rollback the version numbers in the POM files. - - If you want to skip test cases while rebuilding, use - - mvn -DpreparationGoals="clean compile" release:prepare release:perform - -* Review the artifacts, etc. on the Apache Repository (using Sonatype's -Nexus application) site: https://repository.apache.org/. - You will need to login using your ASF SVN credentials and then -browse to the staging area. +``` + +* *Clarify which env var is better or choose one* Set environment variable `MAVEN_OPTS` to `-Xmx1024m` to ensure the tests can run: `export JAVA_OPTIONS="-Xmx1g"` +* If you are outside the US, then svn.apache.org may not resolve to the main US-based Subversion servers. (Compare the IP address you get for svn.apache.org with svn.us.apache.org to see if they are different.) This will cause problems during the release since it will create a revision and then immediately access, but, there is a replication lag of perhaps a minute to the non-US servers. To temporarily force using the US-based server, edit your equivalent of /etc/hosts and map the IP address of svn.us.apache.org to svn.apache.org. +* *Confirm whether the viennacl/etc profiles should be in here* Create the release candidate: `mvn -Pmahout-release,apache-release,hadoop2 release:prepare release:perform` +* If you have problems authenticating to svn.apache.org, try adding to the command line `-Dusername=USERNAME -Dpassword=PASSWORD` +* If there is an issue first try doing: `mvn -Dmahout-release,apache-release,hadoop2 release:rollback` followed by `mvn -Dmahout-release,apache-release,hadoop2 release:clean` as this will likely save you time and do the right thing. You may also have to rollback the version numbers in the POM files. If you want to skip test cases while rebuilding, use `mvn -DpreparationGoals="clean compile" release:prepare release:perform` +* Review the artifacts, etc. on the Apache Repository (using Sonatype's Nexus application) site: https://repository.apache.org/. You will need to login using your ASF SVN credentials and then browse to the staging area. * Once you have reviewed the artifacts, you will need to "Close" out the staging area under Nexus, which then makes the artifacts available for others to see. - * Log in to Nexus - * Click the Staging Repositories link in the left hand menu - * Click the Mahout staged one that was just uploaded by the + 1. Log in to Nexus + 1. Click the Staging Repositories link in the left hand menu + 1. Click the Mahout staged artifact that was just uploaded by the release:perform target - * Click Close in the toolbar. See -https://docs.sonatype.org/display/Repository/Closing+a+Staging+Repository -for a picture - * Copy the "Repository URL" link to your email; it should be like -https://repository.apache.org/content/repositories/orgapachemahout-024/ -* Call a VOTE on [email protected]. Votes require 3 days before -passing. See Apache [release policy|http://www.apache.org/foundation/voting.html#ReleaseVotes] - for more info. -* If there's a problem, you need to unwind the release and start all -over. - <blockquote> - mvn -Pmahout-release,apache-release,hadoop2 versions:set -DnewVersion=PREVIOUS_SNAPSHOT - - mvn -Pmahout-release,apache-release,hadoop2 versions:commit - - git commit - - git push --delete apache <tagname> (deletes the remote tag) - git tag -d tagname (deletes the local tag) - -* Release the artifact in the Nexus Repository in the same way you -Closed it earlier. -* Add your key to the KEYS file at -http://www.apache.org/dist/mahout/<version>/ -* Copy the assemblies and their supporting files (tar.gz, zip, tar.bz2, -plus .asc, .md5, .pom, .sha1 files) to the ASF mirrors at: -people.apache.org:/www/www.apache.org/dist/mahout/<version>/. You should -make sure the group "mahout" owns the files and that they are read only -(-r--r--r-- in UNIX-speak). See [Guide To Distributing Existing Releases Through The ASF Mirrors|http://jakarta.apache.org/site/convert-to-mirror.html?Step-By-Step] - and the links that are there. + 1. Click Close in the toolbar. See https://docs.sonatype.org/display/Repository/Closing+a+Staging+Repository for a picture + 1. Copy the "Repository URL" link to your email; it should be formed like https://repository.apache.org/content/repositories/orgapachemahout-024/ +* Call a VOTE on [email protected]. Votes require 3 days before passing. See Apache [release policy|http://www.apache.org/foundation/voting.html#ReleaseVotes] for more info. +* If there's a problem, you need to unwind the release and start all over. + +``` +mvn -Pmahout-release,apache-release,hadoop2 versions:set -DnewVersion=PREVIOUS_SNAPSHOT +mvn -Pmahout-release,apache-release,hadoop2 versions:commit +git commit +git push --delete apache <tagname> (deletes the remote tag) +git tag -d tagname (deletes the local tag) +``` + +* Release the artifact in the Nexus Repository in the same way you closed it earlier. +* Add your key to the KEYS file at http://www.apache.org/dist/mahout/<version>/ +* Copy the assemblies and their supporting files (tar.gz, zip, tar.bz2, plus .asc, .md5, .pom, .sha1 files) to the ASF mirrors at: people.apache.org:/www/www.apache.org/dist/mahout/<version>/. You should make sure the group "mahout" owns the files and that they are read only (-r--r--r-- in UNIX-speak). See [Guide To Distributing Existing Releases Through The ASF Mirrors|http://jakarta.apache.org/site/convert-to-mirror.html?Step-By-Step] and the links that are there. * cd /www/www.apache.org/dist/mahout * mkdir <VERSION> * cd <VERSION> @@ -232,4 +165,4 @@ details. * more specifics about things to test before starting or after packaging (RAT, run scripts against example, etc...) -* include info about [Voting | http://www.apache.org/foundation/voting.html#ReleaseVotes] \ No newline at end of file +* include info about [Voting | http://www.apache.org/foundation/voting.html#ReleaseVotes]
