Author: bodewig
Date: Thu Aug 31 20:45:00 2006
New Revision: 439161
URL: http://svn.apache.org/viewvc?rev=439161&view=rev
Log:
First cut at release instructions for Antlibs
Added:
ant/antlibs/ReleaseInstructions
- copied, changed from r439160, ant/core/trunk/ReleaseInstructions
Copied: ant/antlibs/ReleaseInstructions (from r439160,
ant/core/trunk/ReleaseInstructions)
URL:
http://svn.apache.org/viewvc/ant/antlibs/ReleaseInstructions?p2=ant/antlibs/ReleaseInstructions&p1=ant/core/trunk/ReleaseInstructions&r1=439160&r2=439161&rev=439161&view=diff
==============================================================================
--- ant/core/trunk/ReleaseInstructions (original)
+++ ant/antlibs/ReleaseInstructions Thu Aug 31 20:45:00 2006
@@ -1,13 +1,14 @@
-Instructions for making a Release:
+Instructions for making an Antlib Release:
Authors: Conor MacNeill
Stefan Bodewig
Magesh Umasankar
Antoine Levy-Lambert
-Note: This document was updated in the context of releasing Ant 1.6.
- Please interpret the branch names, tags, etc. according to
- your context.
+Note: this document is based on Ant core's ReleaseInstructions file
+ <http://svn.apache.org/repos/asf/ant/core/trunk/ReleaseInstructions>
+ and adapted while Stefan was preparing the 1.0 release of the
+ .NET Antlib
1. Propose a release plan for vote. This should set out the timetable for
the release under ideal circumstances. The level of bugs reported
@@ -22,69 +23,40 @@
particularly the release manager will need to make judgement calls here.
Anything too "big" is likely to be held over.
-3. Once the freeze date arrives, create a branch for the release builds. You
- will need to be comfortable in handling CVS branches with mutliple
- merge-backs to the main branch and even selected merges from the the main
- branch to the release branch.
-
- For more information on performing branching and merging, please visit
- http://www.durak.org/cvswebsites/doc/cvs_54.php#SEC54
-
- Label such branches ANT_16_BRANCH.
-
-4. Once the branch is setup, the version numbers in CVS are changed. On the
- branch, the version property in build.xml becomes 1.6Beta,
- while the main branch is updated to 1.7alpha.
+3. The Ant release instructions say you should create a branch at
+ the freeze date. In the case of the Antlibs (and maybe in general) it
+ may be simpler and more convenient to delay the creation of a
+ branch until you want to start new development in trunk.
+
+4. The artefact.version property in build.xml becomes 1.0beta1.
[[ TODO: Check if the documentation files also need to be updated to point
to the right areas of Ant's website. ]]
5. Before a build :
- the first beta on the 1.6 branch should be called 1.6Beta1, ...
+ the first beta should be called 1.0beta1, ...
- the version property in build.xml governs the output of ant -version and
- the naming of the distribution files.
+ the artefact.version property in build.xml governs the naming of
+ the distribution files.
Update the following files for version number:
- On the branch only :
-
- * docs/manual/cover.html
- * docs/manual/credits.html
- * build.xml (version property & manifest-version property)
+ * docs/index.html
+ * build.xml (artefact.version property)
Commit your changes.
- On the branch and on the main trunk (*):
-
- * WHATSNEW
- * xdocs/antnews.xml (Announcement)
- * xdocs/faq.xml (Ant's history details - not for betas)
- * xdocs/index.xml (Announcement, latest release details, link to
- manual under "Documentation")
- * xdocs/srcdownload.xml
- * xdocs/bindownload.xml
-
- Generate the html files by invoking ant on docs.xml
- (use -projecthelp for instructions).
- Commit the modified/generated files
-
-6. Ensure you have all the external libraries that Ant uses in your
- lib/optional directory. To find out what libraries you need, execute
- the build with -verbose option and scan for lines beginning with
- "Unable to load...".
-
-7. Next bootstrap, build and run the tests. Then build the distribution
- on the branch. It is important that this be a clean build. Label this with
- a tag ANT_16_B1.
-
- C:\dev\asf\ant-core>
- svn copy https://svn.apache.org/repos/asf/ant/core/trunk \
- https://svn.apache.org/repos/asf/ant/core/tags/ANT_170_B1 \
- -m "Tagging version 1.7.0Beta1 of Ant"
+6. Ensure you have all the external libraries that the Antlib uses in your
+ available to your build.
- Revision 437509 ?\195?\188bertragen.
+7. Next build and run the tests. Then build the distribution. It is
+ important that this be a clean build. Label this with a tag
+ 1_0B1.
+
+ > svn cp https://svn.apache.org/repos/asf/ant/antlibs/dotent/trunk \
+ https://svn.apache.org/repos/asf/ant/antlibs/dotnet/tags/1_0B1 \
+ -m "Tagging version 1.0beta1 of .NET Antlib"
8. Sign the distribution files using the following simple script
#!/bin/sh
@@ -98,7 +70,7 @@
see <http://www.gnupg.org/(en)/documentation/faqs.html#q5.5>.
Before you do that, ensure that the key you use is inside the KEYS
- file in Ant's CVS repository - and that you perform a cvs update on
+ file in Ant's svn repository - and that you perform an svn update on
the KEYS file in /www/www.apache.org/dist/ant/
Also make sure you have sent the key that you use to a public
@@ -107,7 +79,9 @@
9. The beta distribution is now ready to go. Bundle it up into a tar.gz file
and scp to your apache account.
-10. Meanwhile, convert the part of the WHATSNEW file covering the changes
+10. This step may become meaningful once you do a second release ;-)
+
+ Meanwhile, convert the part of the WHATSNEW file covering the changes
since the last release into HTML for the README file on the
website. See the previous release directories for examples of these files.
Add instructions and warnings (GNU tar format issues, etc).
@@ -120,17 +94,18 @@
[[ TODO: This must perhaps be an Ant task. ]]
11. Once this is uploaded, unpack things, create the release directory,
- something like v1.6Beta1, push the release and RELEASE-NOTES files
+ something like v1.0beta1, push the release and RELEASE-NOTES files
into this directory. Create a symbolic link named README.html
that points to the RELEASE-NOTES.
- The files should go to /www/cvs.apache.org/dist/ant/ on minotaur.
+ The files should go to
+ /www/cvs.apache.org/dist/ant/antlibs/dotnet/ on people.apache.org.
-12. Address the available release tags in BugZilla. Create a new tag 1.6Beta1
- and a 1.7Alpha. Assign all existing 1.6 alpha bugs to one of these release
+12. Address the available release tags in BugZilla. Create a new tag 1.0Beta1
+ and a 1.1Alpha. Assign all existing 1.0 alpha bugs to one of these release
labels. Note that such massive changes can be done at once by choosing the
link "Change several bugs at once" at the bottom of the bug list
- displaying the 1.6alpha bugs.
+ displaying the 1.0alpha bugs.
13. Once that is done, do a test download to make sure everything is OK. A
common problem may be:
@@ -146,8 +121,7 @@
and also perform a cvs update on files in minotaur's
/www/ant.apache.org/
- Announce beta releases at freshmeat.net (Stefan Bodewig is the
- owner of Ant's project entry - bug him ;-).
+ Announce beta releases at freshmeat.net.
14. As problems in the beta are discovered, there may be a need for
one or more subsequent betas. The release manager makes this
@@ -162,8 +136,8 @@
file under /usr/local/apache2/logs
16. When the final beta is considered OK, propose a vote on [EMAIL PROTECTED]
to
- officially adopt the latest beta as the Ant 1.6 release. If it is passed,
- (it usually does,) this would be labelled ANT_16 and built in a similar
+ officially adopt the latest beta as the 1.0 release. If it is passed,
+ (it usually does,) this would be labelled 1_0 and built in a similar
fashion to the above process.
17. BUT
@@ -174,18 +148,22 @@
* upload the new release files to
from distribution
- to /www/www.apache.org/dist/ant/[source|binaries].
+ to /www/www.apache.org/dist/ant/antlibs/dotnet/[source|binaries].
and
+ [TODO need to decide on repository structure]
+
from java-repository/ant/jars
to /www/www.apache.org/dist/java-repository/ant/jars
this can be done using the target upload of the build.xml
- * remove the symbolic links from /www/www.apache.org/dist/ant.
+ * remove the symbolic links from
+ /www/www.apache.org/dist/ant/antlibs/dotnet.
- * Create proper -current symlinks in /www/www.apache.org/dist/ant/
+ * Create proper -current symlinks in
+ /www/www.apache.org/dist/ant/antlibs/dotnet.
* Make sure that the symbolic link README.html points to the new
RELEASE-NOTES.
@@ -194,7 +172,7 @@
18. Update the ant.apache.org site :
- running cvs update *.html under /www/ant.apache.org should update the
+ running svn update *.html under /www/ant.apache.org should update the
files regenerated and committed in point 5 above (index.html, faq.html,
antnews.html, srcdownload.html, bindownload.html).
@@ -203,11 +181,11 @@
19. Clean up.
* remove the remaining files of the previous release from
- /www/www.apache.org/dist/ant/[source|binaries].
+ /www/www.apache.org/dist/ant/antlibs/dotnet/[source|binaries].
This includes the old release notes.
-20. Now and perhaps during previous betas any changes on the branch must
- be merged back into the tree.
+20. If you've created a branch, now and perhaps during previous betas
+ any changes on the branch must be merged back into the tree.
21. At this point in time, the release is done and announcements are made.
PGP-sign your announcement posts.
@@ -220,7 +198,6 @@
announce@apache.org, [EMAIL PROTECTED] and [EMAIL PROTECTED]
Announce release at freshmeat.net
- (Stefan Bodewig is the owner of Ant's project entry - bug him ;-).
Announce release in the usenet groups comp.lang.java.softwaretools
and comp.lang.java.announce.
---------------------------------------------------------------------
To unsubscribe, e-mail: [EMAIL PROTECTED]
For additional commands, e-mail: [EMAIL PROTECTED]
