[Db-derby Wiki] Update of "ReleasePrep" by BryanPendleton

[Apache Wiki <wi...@apache.org>]

Dear Wiki user,

You have subscribed to a wiki page or wiki category on "Db-derby Wiki" for change notification.

The "ReleasePrep" page has been changed by BryanPendleton:
https://wiki.apache.org/db-derby/ReleasePrep?action=diff&rev1=8&rev2=9

    * modify derby web
    * distribute to maven
  
+ Although there are build tools that can automate most of these steps, you must carefully configure your machine and build environment for those tools to work successfully.
+ 
  This means you have to have to be able to do the following / use the following tools ( {i} see: `BUILDING.html`):
-   * md5 {X} The tool for generating md5 sums varies between systems. You may have to use `md5sum` or `digest -a md5`. {i} See also how to configure the [[#CopyPkgTmpl|ant sign target]])
+   * md5 {X} The tool for generating md5 sums varies between systems. You may have to use `md5sum` or `digest -a md5`. Set the `md5.exe` and `md5.options` properties in your `~/ant.properties` file. {i} See also how to configure the [[#CopyPkgTmpl|ant sign target]]
-   * pgp ( {i} see: [[http://people.apache.org/~henkp/trust/]], [[http://gnupg.org]] or [[http://pgp.com.]] )
+   * pgp ( {i} see: [[http://people.apache.org/~henkp/trust/]], [[http://gnupg.org]] or [[http://pgp.com.]] ) Set the `pgp.exec` and `pgp.options` properties in your `~/ant.properties` file.
    * ant
    * dita ( {i} see: [[http://db.apache.org/derby/manuals/dita.html]] )
    * forrest ( {i} see: [[http://db.apache.org/derby/papers/derby_web.html]] )
    * eclipse (optional:)
  
  And you have to have the following files available ( {i} see: `BUILDING.html`):
-   * junit.jar (put this in tools/java)
+   * junit.jar (Normally the build.xml script will download this automatically, but if you do it by hand, put this in tools/java)
    * `DITA-OT1.1.2.1_bin-ASL.zip` ( {i} see: [[http://db.apache.org/derby/manuals/dita.html]])
  
  For 10.12 and earlier, you also need:
@@ -110, +112 @@

  For 10.3 and earlier, you also need:
    * osgi support (for 10.3 and earlier `osgi.jar` - see: `BUILDING.txt` for your version. 10.4 and later always builds this using `tools/java/felix.jar`)
  
- You need to at least have the doc tree and source tree available, and your `ant.properties` file needs to include:
+ For the documentation and source building portions of the build, you need to at least have the doc tree and source tree available, and your `~/ant.properties` file needs to include:
  {{{
  proceed=true
  relnotes.src.reports=<location where you want to save/access the xml scripts for generating release notes>
  docs.root=<location of the root directory of your docs client>
  #sane=<sane should *not* be set>}}}
  
+ But wait! There is more to put in your `~/ant.properties`! So please read on...
+ 
- For 10.4 and earlier, your `ant.properties` file also needs to include:
+ For 10.4 and earlier, your `~/ant.properties` file also needs to include:
  {{{
  j14lib=<location of jdk14(2)/jre/lib>
  jdk16=<location of jdk16>
  jsr169compile.classpath=<location of jsr169 implementation>}}}
  
- {i} Special consideration for non-linux users:
+ {i} Special consideration for the digesting and signing process:
-  {X} [[#CopyPkgTmpl|ant sign]], the last step in the ant release process, may not work. <!> Try it out before the release time arrives!
+  {X} [[#CopyPkgTmpl|ant sign]], the last step in the ant release process, may not work. <!> Try it out before the release time arrives: run `ant -f tools/release/build.xml sign`!
  
-  {X} Your md5 tool may be different. You may need to [[#CopyPkgTmpl|configure the ant sign target for your system]]. {i} For 10.6 and earlier, you this by copying `packaging.tmpl` to `packaging.properties` and adjusting it appropriately for your system. For 10.7 and later, you provide appropriate overrides for the following properties. The default values of these properties are found in packaging.tmpl and you put your overrides in ant.properties:
+  {X} Your md5 tool may be different. You may need to [[#CopyPkgTmpl|configure the `ant sign` target for your system]]. {i} For 10.6 and earlier, you this by copying `packaging.tmpl` to `packaging.properties` and adjusting it appropriately for your system. For 10.7 and later, you provide appropriate overrides for the following properties. The default values of these properties are found in packaging.tmpl and you put your overrides in `~/ant.properties`:
  
  {{{
  md5.exec=<name of your checksumming executable>
  md5.options=<options to be passed on the command line to the checksumming executable>
  pgp.exec=<name of your signing executable>
  pgp.options=<options to be passed on the command line to the signing executable>}}}
- 
-  (!) If you cannot do this, you may achieve the same using [[#SignOne|this script]]. 
  
  Also make sure that you are subscribed to site-dev@apache.org. You may need to prod that list at the end.
  
@@ -156, +158 @@

    * The JSR169 support
  
   1. <<Anchor(CopyPkgTmpl)>>If you are building 10.6 or earlier, copy `tools/ant/properties/packaging.tmpl` to `tools/ant/properties/packaging.properties` and modify as necessary.
-   The build will attempt to use a file called `tools/ant/properties/packaging.properties` to carry out checksum (md5)and signing (pgp) tasks. If you are building 10.7 or later, then override the values in packaging.tmpl as you would any other ant variables: i.e., override them as necessary in ant.properties or on the ant command line.
+   The build will attempt to use a file called `tools/ant/properties/packaging.properties` to carry out checksum (md5)and signing (pgp) tasks. If you are building 10.7 or later, then override the values in packaging.tmpl as you would any other ant variables: i.e., override them as necessary in `~/ant.properties` or on the ant command line (NOTE: `local.properties` does not work for these variables).
  
-   {X} Because this differs per operating system, you have to create this file based on the template (`tools/ant/properties/packaging.tmpl`) or override the values in ant.properties. packaging.tmpl is set for a likely linux environment.  
+   {X} Because this differs per operating system, you have to create this file based on the template (`tools/ant/properties/packaging.tmpl`) or override the values in `~/ant.properties`. packaging.tmpl is set for a likely linux environment.  
  
    {i} Most Unix distributions come with either md5 or md5sum. An md5sum utility for Windows can be downloaded as a part of the !GnuWin32 port of the core Gnu utilities, from: http://gnuwin32.sourceforge.net/packages/coreutils.htm. A standalone md5 utility can be found at http://www.fourmilab.ch/md5/. Note, for the executable available from this last location, the correct option for output is md5 -n.
  
@@ -171, +173 @@

  
    Your KEY needs to be in the `KEYS` file in trunk, `KEYS` file on the branch if you've created one, and the KEYS file in `/www/www.apache.org/dist/db/derby` at `people.apache.org`.
   
-   {X} You need to make sure the `tools/ant/properties/packaging.properties` file (or ant.properties) has correct information for your pgp tool.
+   {X} You need to make sure the `tools/ant/properties/packaging.properties` file (10.6 or earlier), or `~/ant.properties` file (10.7 or later) has correct information for your pgp tool.
  
   1. Ensure you have appropriate jdks available. Unless you are building a 10.12 or earlier release, this is simply Java 8.