You are viewing a plain text version of this content. The canonical link for it is here.
Posted to java-commits@lucene.apache.org by Apache Wiki <wi...@apache.org> on 2010/02/10 14:56:18 UTC
[Lucene-java Wiki] Update of "ReleaseTodo" by UweSchindler
Dear Wiki user,
You have subscribed to a wiki page or wiki category on "Lucene-java Wiki" for change notification.
The "ReleaseTodo" page has been changed by UweSchindler.
The comment on this change is: Add hints for upgrading trunk's main version.
http://wiki.apache.org/lucene-java/ReleaseTodo?action=diff&rev1=69&rev2=70
--------------------------------------------------
svn copy https://svn.apache.org/repos/asf/lucene/java/trunk \
https://svn.apache.org/repos/asf/lucene/java/branches/lucene_X_Y -m "Starting Lucene X.Y branch."
}}}
- 1. After branching the new release series, update the default version in common-build.xml on trunk to X.Y+1-dev and the default version in common-build.xml on the branch to X.Y (remove the -dev suffix). Also update the LUCENE_MAIN_VERSION in src/java/org/apache/lucene/util/Constants.java.
+ 1. After branching the new release series, update the default version in common-build.xml on trunk to X.Y+1-dev and the default version in common-build.xml on the branch to X.Y (remove the -dev suffix). Also update the LUCENE_MAIN_VERSION in src/java/org/apache/lucene/util/Constants.java. Also add the new enum constant into src/java/org/apache/lucene/util/Version.java. Update src/test/org/apache/lucene/util/LuceneTestCaseJ4.java to use the current version.
+ 1. Create a new backwards branch for trunk based on the branch already created for the release. Link this branch in common-build.xml.
1. Update CHANGES.txt and contrib/CHANGES.txt in trunk and the branch. Specify tentative release date and start a new section for X.Y+1-dev in the trunk's CHANGES.txt.
- 1. On trunk, fix src/site/src/documentation/content/xdocs/{tabs.xml,index.xml} to reference the X.Y+1-dev version. Rebuild the website (http://wiki.apache.org/lucene-java/HowToUpdateTheWebsite) and commit.
+ 1. On trunk, fix src/site/src/documentation/content/xdocs/{tabs.xml,index.xml} to reference the X.Y+1-dev version. Rebuild the website (http://wiki.apache.org/lucene-java/HowToUpdateTheWebsite) and commit.
1. On the branch, fix the same files, rebuild the website and commit.
1. Send a note to java-dev to inform the committers that the branch has been created and the feature freeze phase has started. Include Do's and Don'ts for the feature freeze phase:
* No new features may be committed to the branch.
* Documentation patches, build patches and serious bug fixes may be committed to the branch. However, you should submit *all* patches you want to commit to Jira first to give others the chance to review and possibly vote against the patch. Keep in mind that it is our main intention to keep the branch as stable as possible.
* All patches that are intended for the branch should first be committed to trunk and then merged into the branch.
* Normal trunk development may continue as usual. However, if you plan to commit a big change to the trunk while the branch feature freeze is in effect, think twice: can't the addition wait a couple more days? Merges of bug fixes into the branch may become more difficult.
- * *Only* Jira issues with Fix version "X.Y" and priority "Blocker" will delay a release candidate build.
+ * *Only* Jira issues with Fix version "X.Y" and priority "Blocker" will delay a release candidate build.
= Staging Area and Release Candidates =
1. Check out the branch with: {{{svn co https://svn.apache.org/repos/asf/lucene/java/branches/lucene_X_Y}}}
@@ -39, +40 @@
1. Examine the results. Did it build without errors? Were there Javadoc warnings? Did the tests succeed? Does the demo application work correctly?
1. In preparation for the next step, download the Maven ant tasks JAR (eg maven-ant-tasks-2.0.9.jar) from http://maven.apache.org/download.html, and add into your CLASSPATH, or add "-lib XXX.jar" to the ant command in the next step
1. Remove contrib/benchmark/{work,temp} if present
- 1. Package the release with a command like: {{{ant -Dversion=2.3.0-rc1 -Dspec.version=2.3.0 clean dist dist-src generate-maven-artifacts}}}. Make sure it finishes successfully.
+ 1. Package the release with a command like: {{{ant -Dversion=2.3.0-rc1 -Dspec.version=2.3.0 clean dist dist-src generate-maven-artifacts}}}. Make sure it finishes successfully.
1. Generate Changes.html by running {{{ant changes-to-html}}}, then open build/docs/changes/Changes.html with a browser and confirm it looks right.
1. Create a staging area on your public Apache website
{{{
ssh people.apache.org
mkdir public_html/staging-area
}}}
- 1. Copy the release candidate and changes.html to the staging area and announce on java-dev and java-user that it is available for testing. Make sure your directory permissions disallow writing ({{{chmod -R a-w public_html/staging-area/*}}}, after copying).
+ 1. Copy the release candidate and changes.html to the staging area and announce on java-dev and java-user that it is available for testing. Make sure your directory permissions disallow writing ({{{chmod -R a-w public_html/staging-area/*}}}, after copying).
{{{
ssh people.apache.org
mkdir public_html/staging-area/rc1
@@ -82, +83 @@
}}}
1. If this is a new branch (ie you are releasing X.Y.0), after tagging, commit a new "unreleased" section at the top of CHANGES.txt and contrib/CHANGES.txt onto the branch
1. If this is your first release, add your key to the KEYS file. The KEYS file is located in Subversion at [WWW] https://svn.apache.org/repos/asf/lucene/java/dist and copy it to the release directory. Make sure you commit your change.
- 1. If this is a point release, copy the CHANGES.txt entry for this point release back to the trunk's CHANGES.txt. Remove any duplicate entries from trunk's CHANGES.txt (ie, each issue should appear only once, in the earliest point-release that contains the fix, on the assumption that all future releases also contain the fix).
+ 1. If this is a point release, copy the CHANGES.txt entry for this point release back to the trunk's CHANGES.txt. Remove any duplicate entries from trunk's CHANGES.txt (ie, each issue should appear only once, in the earliest point-release that contains the fix, on the assumption that all future releases also contain the fix).
1. See [[http://jakarta.apache.org/site/convert-to-mirror.html?Step-By-Step|Guide To Distributing Existing Releases Through The ASF Mirrors]] and the links that are there.
1. Copy the KEYS file, and the non-Maven release artifacts to the dist directory {{{people.apache.org:/www/www.apache.org/dist/lucene/java}}}, and remove the old files
- 1. Copy the Maven artifacts to the distribution directory (follow the existing directory structure), to have them pushed to the central Maven repositories: {{{people.apache.org:/www/people.apache.org/repo/m2-ibiblio-rsync-repository/org/apache/lucene}}}
+ 1. Copy the Maven artifacts to the distribution directory (follow the existing directory structure), to have them pushed to the central Maven repositories: {{{people.apache.org:/www/people.apache.org/repo/m2-ibiblio-rsync-repository/org/apache/lucene}}}
- 1. Checkout https://svn.apache.org/repos/asf/lucene/java/nightly and change the -Dversion=X.Y-SNAPSHOT in nightly.sh. Also configure the Hudson script (http://hudson.zones.apache.org/hudson/job/Lucene-trunk/configure) and set the -Dversion=X.Y-SNAPSHOT value in the "execute shell" section. Save this change. See http://wiki.apache.org/general/Hudson for how to get a login on hudson, or ask Grant or Michael B. for help.
+ 1. Checkout https://svn.apache.org/repos/asf/lucene/java/nightly and change the -Dversion=X.Y-SNAPSHOT in nightly.sh. Also configure the Hudson script (http://hudson.zones.apache.org/hudson/job/Lucene-trunk/configure) and set the -Dversion=X.Y-SNAPSHOT value in the "execute shell" section. Save this change. See http://wiki.apache.org/general/Hudson for how to get a login on hudson, or ask Grant or Michael B. for help.
1. Wait 24 hours to give the mirrors a chance to get the new release.
= Announcing =
- 1. Checkout the top-level Lucene website from https://svn.apache.org/repos/asf/lucene/site. Add a new item under "News", in index.xml. Run "forrest site", confirm all looks good, then recursively copy build/site/* to publish/*, then commit the changes. Then copy publish/* to /www/lucene.apache.org/* on people.apache.org.
+ 1. Checkout the top-level Lucene website from https://svn.apache.org/repos/asf/lucene/site. Add a new item under "News", in index.xml. Run "forrest site", confirm all looks good, then recursively copy build/site/* to publish/*, then commit the changes. Then copy publish/* to /www/lucene.apache.org/* on people.apache.org.
- 1. Checkout the Lucene java website from https://svn.apache.org/repos/asf/lucene/java/site. Add a new item under "Lucene News", in index.xml. Add a new entry for this release into both tabs.xml and site.xml. Run "forrest site", confirm all looks good, and recursively copy build/site/* to docs/*, then commit the changes. Copy docs/* to /www/lucene.apache.org/java/docs on people.apache.org. Make sure .htaccess is copied!
+ 1. Checkout the Lucene java website from https://svn.apache.org/repos/asf/lucene/java/site. Add a new item under "Lucene News", in index.xml. Add a new entry for this release into both tabs.xml and site.xml. Run "forrest site", confirm all looks good, and recursively copy build/site/* to docs/*, then commit the changes. Copy docs/* to /www/lucene.apache.org/java/docs on people.apache.org. Make sure .htaccess is copied!
1. Copy the release specific docs to people.apache.org:
{{{
ssh people.apache.org
@@ -99, +100 @@
mv lucene-X.Y.Z/docs /www/lucene.apache.org/java/X_Y_Z
rmdir lucene-X.Y.Z
}}}
- 1. Make sure the group ownership on the site is 'lucene' by calling {{{chgrp -R lucene /www/lucene.apache.org/java}}}. Also make files group writable and others read-only by calling {{{chmod -R g+w,o-w /www/lucene.apache.org/java}}}.
+ 1. Make sure the group ownership on the site is 'lucene' by calling {{{chgrp -R lucene /www/lucene.apache.org/java}}}. Also make files group writable and others read-only by calling {{{chmod -R g+w,o-w /www/lucene.apache.org/java}}}.
1. Copy the Changes.html you previously generated to the website: {{{scp -r build/docs/changes people.apache.org:/www/lucene.apache.org/java/X_Y_Z}}}
- 1. Wait for these changes to appear on Apache's main webserver (http://lucene.apache.org) before doing the next steps (see http://www.apache.org/dev/project-site.html for details on how the site is mirrored to Apache's main web servers). Once they appear, verify all links are correct in your changes!
+ 1. Wait for these changes to appear on Apache's main webserver (http://lucene.apache.org) before doing the next steps (see http://www.apache.org/dev/project-site.html for details on how the site is mirrored to Apache's main web servers). Once they appear, verify all links are correct in your changes!
1. Announce the release on http://www.freshmeat.net
1. Announce the release on general@lucene.apache.org , java-dev@lucene.apache.org , java-user@lucene.apache.org and announce@apache.org mailing lists. A draft should be sent to the development list first to clarify any possible issues in the announcement. Mails to the announce list should be sent from an @apache.org email address and contain a signature.
- 1. Ensure the latest Lucene Jar + MD5 sum file have been pushed to http://repo1.maven.org/maven2/org/apache/lucene/ by deploying the distribution to http://people.apache.org/repo/m2-ibiblio-rsync-repository/ (that is minotaur.apache.org:/www/people.apache.org/repo/m2-ibiblio-rsync-repository). From there it will be pushed to the central Maven repositories (both Maven 1 and Maven 2) automatically in a few hours. Contact repository@apache.org if there's some problem.
+ 1. Ensure the latest Lucene Jar + MD5 sum file have been pushed to http://repo1.maven.org/maven2/org/apache/lucene/ by deploying the distribution to http://people.apache.org/repo/m2-ibiblio-rsync-repository/ (that is minotaur.apache.org:/www/people.apache.org/repo/m2-ibiblio-rsync-repository). From there it will be pushed to the central Maven repositories (both Maven 1 and Maven 2) automatically in a few hours. Contact repository@apache.org if there's some problem.
- 1. Go to the JIRA "Manage Versions" Administration page (http://issues.apache.org/jira/secure/project/ManageVersions.jspa?pid=12310110) and click Release for the version you just released. Also add a new (unreleased) version for the next release on the trunk (for a major release) or branch (for a minor release).
+ 1. Go to the JIRA "Manage Versions" Administration page (http://issues.apache.org/jira/secure/project/ManageVersions.jspa?pid=12310110) and click Release for the version you just released. Also add a new (unreleased) version for the next release on the trunk (for a major release) or branch (for a minor release).
- 1. Go to JIRA and find all issues that were fixed in the release you just made, whose Status is Resolved, and do a bulk change to close all of these issues. Uncheck the box that says "send an email for these changes".
+ 1. Go to JIRA and find all issues that were fixed in the release you just made, whose Status is Resolved, and do a bulk change to close all of these issues. Uncheck the box that says "send an email for these changes".
= See Also =
* [[http://www.apache.org/dev/release.html|Apache Releases FAQ]]