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 Tue, 18 Mar 2008 12:54:06 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

------------------------------------------------------------------------------
  
   1. Create wiki pages for the release. (Unless you have already done so. It may be convenient
to have a Wiki page prior to feature freeze and branch cutting). Use pages for a previous
release as a template. You're likely to create a general page and a page to hold the testing
information.
  
-  1. For major releases, create a new branch for the release, in both the code and docs trees.
+  1. [[Anchor(CutBranch)]]For major releases, create a new branch for the release, in both
the code and docs trees.
  
    {{{svn copy -r {rev} https://svn.apache.org/repos/asf/db/derby/code/trunk/ https://svn.apache.org/repos/asf/db/derby/code/branches/{branchname}/
-m "Created the {branchname} source branch"
  svn copy -r {rev} https://svn.apache.org/repos/asf/db/derby/docs/trunk/ https://svn.apache.org/repos/asf/db/derby/docs/branches/{branchname}/
-m "Created the {branchname} doc branch"}}}
@@ -131, +131 @@

    * distribute to maven
  
  This means you have to have to be able to do the following / use the following tools:
-   * md5 
+   * md5 (aka. `md5sum` or `digest -a md5`. See also how to [#CopyPkgTmpl configure `ant
sign`])
    * pgp (see: [http://people.apache.org/~henkp/trust/], [http://gnupg.org] or [http://pgp.com.]
)
    * ant (see BUILDING.txt)
    * dita (see: [http://db.apache.org/derby/manuals/dita.html] )
@@ -155, +155 @@

  relnotes.src.reports=<location where you want to save/access the xml scripts for generating
release notes>
  #sane=<sane should *not* be set>}}}
  
- Special consideration for windows users:
+ Special consideration for non-linux users:
-   * ant sign, the last step in the ant release process, may not work. 
+   * [#CopyPkgTmpl `ant sign`], the last step in the ant release process, may not work.
-   try it out before the release time is there; if you cannot do this, you may achieve the
same using  the following script 
+   try it out before the release time is there; if you cannot do this, you may achieve the
same using [#SignOne this script]. 
-   * similarly, you may use a script to verify the release
+   * Similarly, you may use a script to verify the release
-   * your md5 tool may be different.
+   * Your md5 tool may be different.
-   you'll need to copy the file packaging.tmpl to packaging.properties and adjust it appropriately.
+   you'll need to [#CopyPkgTmpl copy the file packaging.tmpl to packaging.properties and
adjust it appropriately].
  
  ==== Steps to prepare your machine/code check-out for the release process ====
  
@@ -179, +179 @@

    * The OSGi support (osgi.jar or felix.jar. Felix.jar should be automatically present in
tools/java with 10.4 and later).
    * The JSR169 support
  
-  1. Copy tools/ant/properties/packaging.tmpl to tools/ant/properties/packaging.properties
and modify as necessary.
+  1. [[Anchor(CopyPkgTmpl)]]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. Because this differs per operating system,
you have to create this file based on the template (tools/ant/properties/packaging.tmpl) which
is set for a likely linux environment.  
  
@@ -214, +214 @@

    To build the documentation, you need to obtain DITA-OT1.1.2.1_bin-ASL.zip and place it
in the docs' tree lib. See: [http://db.apache.org/derby/manuals/dita.html] for more info about
building the documentation.
  
  [[Anchor(FirstRC)]]
- === For the first release candidate ''on a new branch'' ===
+ === For the first release candidate on a new branch ===
  
   1. Update `tools/ant/properties/release.properties` by hand, and set the `beta` property
to false.
   1. Create `maintversion.properties`, by running:
    {{{java org.apache.derbyBuild.maintversion2props tools/ant/properties/release.properties

  tools/release/maintversion.properties}}}
-   This step will ''not'' modify any files under version control, but you will need the unversioned
`maintversion.properties` when you [#CreateDistros create the distributions] later on.
+   This step will ''not'' modify any files under version control, but you will need the unversioned
`maintversion.properties` when you [#CreateDistros create the distributions] later on. '''
/!\ Is this really true? Seems like this is done automagically when building the release artifacts?'''
   1. Check in the modification.
   1. You will need to clobber and build again before you can see the changed `beta` property
reflected in the source. Note that the first release off a new branch is automatically beta,
even if you set the `beta` property to false.
  
  [[Anchor(ForEachRC)]]
  === For each release candidate ===
  
+ Verify that:
+  * `beta` property is false. If this is the first release candidate off this branch the
`beta` property should have been set to false in a [#FirstRC previous section].  If this is
an update relase, the `beta` property should have been set to false as a part of the release
cycle for the first release off this branch. Note that removing the beta flag will not have
an effect unless the 3rd digit (fixpack) is greater than 0, since version numbers with fixpack=0
always are considered alpha. Fixpack (3rd digit) will normally be set to 1 when the [#BranchCutting
branch is cut], but if it isn't, it must be incremented before the release candidate can be
created. 
+  * Version number is correct. For the first release candidate off a branch, the version
number should have been set immediately [#BranchVersion after cutting the branch]. For subsequent
release candidates, including update release candidates, the version number should have been
bumped after [#Bump4th spinning the previous release candidate]
+ 
  ==== Check-ins just before generating release artifacts ====
  
+ /!\ '''Check in the new version number after RC is spun?''' 
-  1. Verify that 
-   * `beta` property is false
-   * Version number is correct
-   * /!\ '''Check in the new version number after RC is spun?''' For the '''first''' release
candidate on a branch:  and create , and check in the new version of `release.properties`.
  
-  1. Also adjust version numbers in documentation by modifying the appropriate *conrefs.dita
files.
+  1. Also adjust version numbers in documentation by modifying the appropriate `*conrefs.dita`
files.
  
-  1. Generate RELEASE_NOTES.html in the branch and check it into the svn repository.
+  1. Generate `RELEASE_NOTES.html` in the branch and check it into the svn repository. Please
consult the instructions for [http://wiki.apache.org/db-derby/ReleaseNoteProcess generating
release notes].
  
-   Please consult the instructions for [http://wiki.apache.org/db-derby/ReleaseNoteProcess
generating release notes].
- 
-  1. finalize CHANGES. This can include items in addition to the RELEASE_NOTES, which are
purely for user purposes. 
+  1. ( /!\ ''Deprecated for versions >= 10.3'') Finalize CHANGES. This can include items
in addition to the RELEASE_NOTES, which are purely for user purposes. 
    The tool java/tools/ChangesFileGenerator.java can help you generate this file; it works
similar to the ReleaseNotesGenerater.
  
   1. Check in the latest SQLState documentation.
  
-   Build the source tree. The SQLStates are documented in the Reference Guide on the following
page: rrefexcept71493.dita. This file is generated by the Derby build and placed in classes/doc.
Take the version of this file generated by building the code branch and check it into the
doc branch at src/ref/rrefexcept71493.dita.
+   Build the source tree. The SQLStates are documented in the Reference Guide on the following
page: `rrefexcept71493.dita`. This file is generated by the Derby build and placed in `classes/doc`.
Take the version of this file generated by building the code branch and check it into the
doc branch at `src/ref/rrefexcept71493.dita`.
  
   1. Sync the source and doc repository.
  
@@ -257, +256 @@

  	- doc tree
  	  - with DITA library
  	  - with latest SQLState
- 	- KEYS checked in
+ 	- `KEYS` checked in
- 	- RELEASE_NOTES and CHANGES checked in
+ 	- `RELEASE_NOTES` and CHANGES(''not for 10.3 and higher'') checked in
- 	- md5 & pgp and docs info set correctly in tools/ant/properties/packaging.properties
and available (PATH)
+ 	- `md5` & `pgp` and docs info set correctly in `tools/ant/properties/packaging.properties`
and available (PATH)
- 	- generated updated tools/release/maintversion.properties
+ 	- generated updated `tools/release/maintversion.properties` ( /!\ ''' Is it still required?''')
- 	- ant.properties set correctly for:
+ 	- `ant.properties` set correctly for:
  		osgi.jar(10.3 and earlier), jdk15, jdk16, jsr169
- 	- sane not set in ant.properties
+ 	- sane not set in ant.properties /!\ ''' Is this still true?'''
- 	- non-source files for building source available: junit.jar, (with 10.3 and earlier: osgi.jar),
dita library (again).
+ 	- non-source files for building source available: `junit.jar`, `felix.jar`, (with 10.3
and earlier: `osgi.jar`), dita library (again).
   
   1. Build the documentation.
  
@@ -304, +303 @@

  md5 -q derby_ui_plugin_[version].zip > derby_ui_plugin_[version].zip.md5
  md5 -q derby_core_plugin_[version].zip > derby_core_plugin_[version].zip.md5}}}
  
-   There is a problem with the Ant 'sign' target on Cygwin that may occur elsewhere. If for
some reason the Ant 'sign' target hangs, it may be prompting and waiting for input that you
cannot see. In that case, you can also use this simple script to automate signing the release
archives:
+   [[Anchor(SignOne)]]There is a problem with the `ant sign` target on Cygwin that may occur
elsewhere. If for some reason the Ant 'sign' target hangs, it may be prompting and waiting
for input that you cannot see. In that case, you can also use this simple script to automate
signing the release archives:
  
    {{{#!/bin/sh signone() {
    gpg --detach-sign --armor $1
@@ -347, +346 @@

  
  Keep the jars/insane/*.jar files available. You will need them for maven deployment after
the vote is complete.
  
-  1. Bump the fourth digit of the source in preparation for a possible next build
+  1. [[Anchor(Bump4th)]]Bump the fourth digit of the source in preparation for a possible
next build
    You should update tools/ant/properties/release.properties by hand and then run:
    {{{java org.apache.derbyBuild.maintversion2props tools/ant/properties/release.properties
tools/release/maintversion.properties}}}
+   The third and fourth parts of the version are combined into a single property, maint,
where maint = (third digit * 1000000) + fourth digit. 
-   /!\ '''This really belongs further down, where preparations for the next RC is made?'''
The third and fourth parts of the version are combined into a single property, maint, where
maint = (third digit * 1000000) + fourth digit. Also, if this is a major/minor (feature) release,
you should set the beta property to false at this time. Note that removing the beta flag will
not have an effect unless the 3rd digit (fixpack) is greater than 0, since version numbers
with fixpack=0 always are considered alpha. Fixpack (3rd digit) will normally be set to 1
when the [#BranchCutting branch is cut], but if it isn't, it must be incremented before the
release candidate can be created. It will usually ''not'' be necessary to bump point (4th
digit) for the ''first'' release candidate, but this step is obviously required for later
release candidates. E.g. for the ''second'' 10.4 release candidate, `release.properties` would
look something like:
-   {{{#Wed Jul 19 08:21:42 PDT 2006
- drdamaint=0
- maint=1000001
- major=10
- minor=4
- eversion=10.4
- beta=false
- copyright.comment=Copyright 1997, 2008 The Apache Software Foundation or its licensors,
as applicable.
- vendor=The Apache Software Foundation}}}
   
   1. Post the distributions
  

Mime
View raw message