db-derby-commits mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From Apache Wiki <wikidi...@apache.org>
Subject [Db-derby Wiki] Update of "DerbySnapshotOrRelease" by DyreTjeldvoll
Date Thu, 01 May 2008 16:40:29 GMT
Dear Wiki user,

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

The following page has been changed by DyreTjeldvoll:
http://wiki.apache.org/db-derby/DerbySnapshotOrRelease

------------------------------------------------------------------------------
    <!> Make sure that all files and directories have permissions that makes them accessible
on the web! Note that you will not be able to verify this in a web browser until the new directories
and files have been rsynced to real webserver.
   
   1. Create a page for the release, build/update site
- 
    {i} For instructions on how to build the website using Forrest, please see: [http://db.apache.org/derby/papers/derby_web.html]
  
+   a. Create an .html file for the release. The main thing to remember is that the .cgi file
should have the same name as the .html file. 
-   (!) It is a good idea to use the previous release pages as templates, filling in the changed
details as necessary. 
+    (!) It is a good idea to use the previous release pages as templates, filling in the
changed details as necessary. 
  
-   You should add a .cgi and a .html file for the release. The main thing to remember is
that the .cgi file should have the same name as the .html file. 
+    {{{cd src/documentation/content/xdocs/releases
+ cp release-x'.y'.z'.w'.html release-x.y.z.w.html
+ vi release-x.y.z.w.html
+ }}}
  
-   a. Update the derby_downloads.xml page in the src/documentation/content/xdocs directory
so that the links to the new files are included.
-    Note the following things when creating the release page:
+    <!> Note the following things when creating the release page:
-    * Be sure to specify that the src.tar.gz requires gnu tar to unravel (because of our
usage of ant tar to create this, using longfile=gnu for handling long filenames).
+     * Be sure to specify that the src.tar.gz requires gnu tar to unravel (because of our
usage of ant tar to create this, using longfile=gnu for handling long filenames).
+     * Use search-and-replace to change all occurences of the old version number to the new
one.
+     * Replace the old release notes section with the appropriate fragment from `RELEASE_NOTES.html`
in the new release.
+     * Remove all square brackets [] from the release notes page. When the cgi machinery
sees square brackets, it truncates the release page. (Should be handled by the ReleaseNote
vetter?)
+ 
+   a. In order for the release HTML file to be pulled into the build, it is necessary to
add a line to the <uris> section of `src/documentation/conf/cli.xconf`. Near line 310
of that file, add: `<uri type="append" src="releases/release-x.y.z.w.html"/>` (with
the correct version for your release).
+ 
+   a. You should add a .cgi 
     * Forrest will not copy the release .cgi script over unless you make a link to it from
another page. Add the link to derby_downloads.html before building.
-    * Remove all square brackets [] from the release notes page. When the cgi machinery sees
square brackets, it truncates the release page.
     * Make sure that the .cgi script is made executable by setting svn:executable on it with
{{{svn propset 
  svn:executable ON release-10.1.2.1.cgi}}}. Be sure to do this for both the precursor version
you created in src/documentation/content/xdocs/releases and for the generated copy which forrest
builds into build/site/releases.
-    * In order for the release HTML file to be pulled into the build, it is necessary to
add a line to the <uris> section of src/documentation/conf/cli.xconf. Near line 310
of that file, add: <uri type="append" src="releases/release-10.1.2.1.html"/> (with the
correct version for your release)
+ 
+   a. Update the `derby_downloads.xml` page in the `src/documentation/content/xdocs` directory
so that the links to the new files are included.
+ 
-    * Svn delete the cgi script for the previous release. Also, edit its release page to
remove the cgi boilerplate and convert the distribution links from mirror references to ordinary
links. This means removing the [preferred] tags. To see what this should look like, look at
the release page for an even older release.
+   a. Svn delete the cgi script for the previous release. Also, edit its release page to
remove the cgi boilerplate and convert the distribution links from mirror references to ordinary
links. This means removing the [preferred] tags. To see what this should look like, look at
the release page for an even older release.
-    * Subversion may report some files as changed which should be static. Revert anything
in build/site/skin or build/site/papers before committing your website changes ([http://db.apache.org/derby/papers/derby_web.html#odd_diffs
see the explanation]).
  
    a. Run 'forrest site' at the top of the site tree.
+    {i} [http://db.apache.org/derby/papers/derby_web.html Forrest instructions]
  
-    {X} Due to [http://issues.apache.org/jira/browse/FOR-480 FOR-480], the release page will
be built into your `$FORREST_HOME/main/site` directory. You will need to copy it to the build
directory. The build process frequently will create "false modifications" in `build/tmp` or
`build/site/skin`. These must be reverted before checking in the changes.
+    {X} Due to [http://issues.apache.org/jira/browse/FOR-480 FOR-480], the release page will
be built into your `$FORREST_HOME/main/site` directory. You will need to copy it to the build
directory. 
+ 
+    {X} The build process frequently will create "false modifications" in `build/tmp` or
`build/site/skin`. These must be reverted before checking in the changes. Subversion may report
some files as changed which should be static. Revert anything in build/site/skin or build/site/papers
before committing your website changes ([http://db.apache.org/derby/papers/derby_web.html#odd_diffs
see the explanation]).
  
     {{{cd webtrunk
  rm -rf $FORREST_HOME/main/site/*  # Remove any files from a previous build
@@ -517, +529 @@

  
    a. Check the changes. If they look good, 'svn commit' them.
  
-   a. Update the website on `people.apache.org` by logging into the machine and doing:
+   a. Update the website on `people.apache.org`:
  
+    {{{ssh you@people.apache.org
-    {{{cd /www/db.apache.org/derby
+ cd /www/db.apache.org/derby
  svn up}}}
  
     <!> Note that `people.apache.org` is rsync'd to the actual website every hour or
so. Verify that the new release appears on the [http://db.apache.org/derby/derby_downloads.html
Derby download page]. Also check you still can download any release for which you disabled
mirroring. Finally check that you can access the new documentation at the [http://db.apache.org/derby/manuals/index.html
documentation page].

Mime
View raw message