Author: scantor
Date: Mon Mar 23 19:08:02 2015
New Revision: 1668701
URL: http://svn.apache.org/r1668701
Log:
Update release procedure to match steps followed for 3.1.2 release
Modified:
xerces/c/admin/release-procedure.txt
Modified: xerces/c/admin/release-procedure.txt
URL:
http://svn.apache.org/viewvc/xerces/c/admin/release-procedure.txt?rev=1668701&r1=1668700&r2=1668701&view=diff
==============================================================================
--- xerces/c/admin/release-procedure.txt (original)
+++ xerces/c/admin/release-procedure.txt Mon Mar 23 19:08:02 2015
@@ -1,120 +1,96 @@
The following steps are the rough guide to making a release. Please
update it if you find something inaccurate/missing.
-NOTE by Boris: A lot of things *are* wrong in this guide.
+This information is accurate as of the 3.1.2 release, which eliminated some
+aspects of the release process (no binaries, elimination of the 2.8.0 web
+site content).
-1. Update the release information in the following files:
+Note that if a security issue is involved, you may need to edit content in
+doc/secadv.xml and the doc/html/secadv/ directory as part of the release.
- projects/Win32/VC6/xerces-all/XercesLib/XercesLib.dsp
- projects/Win32/VC6/xerces-all/XercesLib/XercesLib.mak
- projects/Win32/VC7.1/xerces-all/XercesLib/XercesLib.vcproj
- projects/Win32/VC8/xerces-all/XercesLib/XercesLib.vcproj
- scripts/packageBinaries.pl
- src/xercesc/configure.in
- src/xercesc/util/XercesVersion.hpp
- src/xercesc/util/MsgLoaders/ICU/ICUMsgLoader.cpp
- src/xercesc/util/MsgLoaders/ICU/resources/res-file-list-unix.txt
- src/xercesc/util/MsgLoaders/ICU/resources/res-file-list-wins.txt
- src/xercesc/util/MsgLoaders/ICU/resources/res-file-list.txt
+1. Update the version information in the following files (many only need
changes
+ if the minor version increases, not just the patch version):
+
+ configure.ac
version.incl
xerces-c.spec
doc/Doxyfile
doc/style/dtd/entities.ent
+ projects/Win32/VC7.1/xerces-all/XercesLib/XercesLib.vcproj
+ projects/Win32/VC8/xerces-all/XercesLib/XercesLib.vcproj
+ projects/Win32/VC9/xerces-all/XercesLib/XercesLib.vcproj
+ projects/Win32/VC10/xerces-all/XercesLib/XercesLib.vcxproj
+ projects/Win32/VC11/xerces-all/XercesLib/XercesLib.vcxproj
+ projects/Win32/VC12/xerces-all/XercesLib/XercesLib.vcxproj
+ src/xercesc/util/XercesVersion.hpp
+ src/xercesc/util/MsgLoaders/ICU/ICUMsgLoader.cpp
-2. Update the release documentation in the following files:
+2. Update the release documentation in (at least) the following files:
doc/migration.xml
doc/migration_archive.xml
- credits.txt
- web/doc/releases.xml
- web/doc/releases_archive.xml
- web/doc/feedback.xml
-
-3. Build and test the release on the platforms that binaries are being
- produced for. The source packages should be named
- xerces-c-x.y.z.zip/tar.gz.
- In order for rpm to work correctly the actual directory containing the
- source that will be zipped/tarred up should be xerces-c-x.y.z.
- The binary packages should be named
- xerces-c-x.y.z-{arch}-{os}-{compiler}.zip/tar.gz.
-
-4. Generate PGP/GNUPG signatures for dist binaries and source packages.
- That is, add public key to the SVN KEYS file if necessary and make sure
- public key is on a key server or two. You will also need to update the
- KEYS file on the website:
+ doc/releases.xml
+ doc/releases_archive.xml
+ doc/releases_plan.xml
+
+3. Build and test the release on the platforms that the PMC indicates should be
+ considered "official". The four source packages should be named
+ xerces-c-x.y.z.zip/tar.gz/tar.bz2/tar.xz, and the distribution content
+ should be explicitly, and only, that produced by the make dist command.
+
+4. Build the web site and API docs by running the following commands from
within
+ the distribution (note that both Oracle's Java and doxygen must be
installed):
+
+ $ cd tools
+ $ ./createdocs.sh
+ $ cd ../doc
+ $ doxygen
- scp KEYS [email protected]:/www/www.apache.org/dist/xml/xerces-c
+ You should be able to open the web site from doc/html/index.html and verify
+ the content.
-5. Upload the binaries and signatures to the dist section of the website,
- from the directory containing the binaries:
-
- scp *
[email protected]:/www/www.apache.org/dist/xml/xerces-c/binaries
-
-6. Upload the source packages and signatures to the dist section of the
- website, from the directory containing the sources:
-
- scp *
[email protected]:/www/www.apache.org/dist/xml/xerces-c/source
-
-7. Logon to minotaur.
-
- ssh minotaur.apache.org
-
-8. Generate md5 signatures for dist binaries and sources on minotaur using:
-
- md5 -r xerces-c_x_y_z.tar.gz > xerces-c_x_y_z.tar.gz.md5
-
-9. Make sure the packages have the correct permissions (chmod 664*).
-
-10. Remove the previous release source and binaries (double checked that
- they are archived) in the source and binaries directories. Remove the
- links in the /www/www.apache.org/dist/xml/xerces-c directory (*current*
- that were pointing at the old sources in the source directory).
+5. Generate PGP/GNUPG signatures for all source distribution packages.
+ That is, add public key to the KEYS file in svn if necessary and make sure
+ public key is on a key server or two. You will also need to update the
+ KEYS file on the website, which is located in svn at:
-11. Create the new links for the source (do for each file including asc
- and md5):
+ https://dist.apache.org/repos/dist/release/xerces/c/KEYS
- ln -s ./source/xerces-c-src_x_y_z.zip xerces-c-current.zip
+6. Generate MD5, SHA1, and SHA256 hashes of the distribution files.
-12. Go to the archive, /www/archive.apache.org/dist/xml/xerces-c and create
- a directory for the previous release (xerces-c-x.y.z). Move over the
- contents of the source and binaries directories to this new directory.
- Remove the *current* links.
+7. Check in the distributions, hashes, and signatures to the dist repository,
in:
-13. Update the archive.
+ https://dist.apache.org/repos/dist/release/xerces/c/3/sources/
- cd /www/www.apache.org/dist/xml/xerces-c
- cp -R * /www/archive.apache.org/dist/xml/xerces-c
+ You should also remove the previous version from svn.
-14. Verify that the downloads are available. Note that it can take up to
+8. Verify that the downloads are available. Note that it can take up to
24 hours to for the mirrors to be updated.
-15. Update the website by taking a binary package and extracting the
- doc/html directories. The web pages are stored in
- /www/xml.apache.org/xerces-c. You will also need to update the
- documentation pdf in the pdf directory (which has both a pdf and
- pdf.tar.gz). Recommend copying the new documentation over the
- existing files. Be sure to change the permissions on the files
- and directories:
-
- find . -type f -exec chmod 664 {} ;
- find . -type d -exec chmod 775 {} ;
-
- If the binaries are for different platforms you may also need to
- update the download.html file to point to the new binaries.
- Verify that the website is updated (may take a while to be
- refreshed on the real webserver).
-
-16. Send out an announcement e-mail to the [email protected] and
- [email protected] mailing lists and cc the
- [email protected] and [email protected] mailing lists.
-
-17. Update the list of versions in Jira for xerces-c.
-
-18. Tag the release in SVN (tags for releases usually have the form
- Xerces-C_x_y_z where x.y.z is the Xerces-C release number) by doing:
-
- svn copy https://svn.apache.org/repos/asf/xerces/c
https://svn.apache.org/repos/asf/xerces/c/tags/Xerces-C_x_y_z \ -m "Tagging the
Xercesc x.y release"
+9. Tag the release in SVN (tags for releases usually have the form
+ Xerces-C_x_y_z where x.y.z is the Xerces-C release number) by doing
(e.g.,):
- For more information on tagging see
- http://svnbook.red-bean.com/nightly/en/svn.branchmerge.tags.html.
+ svn cp -m "Tagging the Xercesc x.y.z release" \
+ https://svn.apache.org/repos/asf/xerces/c/branches/xerces-3.1 \
+ https://svn.apache.org/repos/asf/xerces/c/tags/Xerces-C_x_y_z
+
+ The exact command will depend on the release being done, and where the
original
+ source is.
+
+10. Close any resolved issues in Jira, and "release" the new version. Update
the list
+ of future versions to ensure a patch version and a minor version are
available to
+ assign issues against.
+
+11. Update the website by copying the generated HTML in doc/html over the
+ checked in web site content located at:
+
+ https://svn.apache.org/repos/asf/xerces/site/trunk/production/xerces-c
+
+ You should either remove the original site content and commit that first,
+ or if you want to avoid the site being completely deleted online if there's
+ a problem, copy the content into a sandbox, then look for unchanged files
+ older than the time of the copy, and remove them from svn as part of the
+ site commit.
+12. Send out an announcement e-mail to the [email protected] and
+ [email protected] mailing lists.
---------------------------------------------------------------------
To unsubscribe, e-mail: [email protected]
For additional commands, e-mail: [email protected]
