On Wed, Sep 3, 2008 at 5:05 PM, Joe Bohn <[EMAIL PROTECTED]> wrote: > Ted Kirby wrote: >> >> For this to work, trunk/RE*.txt should not be copied to distribution >> web site, but rather >> trunk/assemblies/geronimo-boilerplate/target/classes/contents/RE*.txt, >> which are the substituted versions. (I suppose we might enhance the >> build to copy these files to trunk/target/RE*.txt. I also wonder if >> this substituted version might be put in the distributed source .zip?) >> These substituted versions are in the .zip files. The doc should >> then refer to the versions on the distribution web site. > > It sounds like we are trading one maintenance issue for another.
I don't see an maintenance issue here, just getting the build the way we like it, and a procedure change in terms of where we get the RE*.txt files from that we put on the distribution web site, unless I am missing something here. Once this is done, I think the major cases are covered. The source case is what is left. If they intend to build the source, @VERSION@ will be expanded. Maybe we add a note about if you see @VERSION@, you have source. It will be expanded on build. The version of the source you have can be found from the name of the RELEASE_NOTES file in this directory: "[EMAIL PROTECTED]@.txt". >> >> That would leave the svn checkout case. >> >> RELEASE_NOTES is less of a concern, I think, since the version number >> is part of the file's name, as in RELEASE_NOTES-2.2-SNAPSHOT.txt. > > I'm not sure if this is less of a concern. The RELEASE_NOTES have to be > manually updated for each release anyway to generate the JIRA lists, add > functions, etc.... It doesn't seem like a big deal to me to add in > changing the version number along with everything else. Agreed. Other manual editing is required here. Just a small thing (version number) to not have to worry about. >> >> For it and the problematic README.txt, a comment might be added near >> the top of the file defining what the @VERSION@ is. (i.e., "the >> @VERSION@ of this file is 2.2") It would be a manual step to update >> this comment. :-(. >> >> It seems there are a few places where @VERSION@ might be removed >> altogether. > > Yes, it could probably be removed in several places. However I think it > still must be there in some form or fashion (esp. to indicate the > enhancements included in major releases). The other downside of the > @VERSION@ in the README is that we specifically reference the RELEASE-NOTES > from the README. It is probably more helpful to reference this by it's > exact name rather than make the user translate. I think it's worth some > extra effort on our part to save the user some grief/confusion. The README already has "Please read the [EMAIL PROTECTED]@.txt" for this reference. This JIRA is not a big thing. It can be reverted if desired. Just a small step to try to automate some parts of the process. While not without issues, it seems a good thing on the whole moving forward. Any other opinions out there? Ted >> >> Ted >> >> On Wed, Sep 3, 2008 at 4:25 PM, Joe Bohn <[EMAIL PROTECTED]> wrote: >>> >>> While I like the idea of this change (and I'm certainly in favor of less >>> maintenance when changing versions) ... I wonder if it is an appropriate >>> change. >>> >>> IIUC one of the reasons for the README & RELEASE_NOTES being in the root >>> of >>> the svn tree was for users that pull the source from SVN or pull it from >>> the >>> extracted/zipped version that we make available upon release. This change >>> makes those docs a bit less useful. We also include these documents >>> (copied >>> from the svn root) in our distribution directory and reference them from >>> the >>> web pages. Seeing @VERSION@ peppered throughout the document doesn't >>> seem >>> very good. >>> >>> Thoughts? >>> >>> Joe >>> >>> >>> >>> [EMAIL PROTECTED] wrote: >>>> >>>> Author: tkirby >>>> Date: Wed Sep 3 08:21:49 2008 >>>> New Revision: 691633 >>>> >>>> URL: http://svn.apache.org/viewvc?rev=691633&view=rev >>>> Log: >>>> GERONIMO-4274 Automate version numbers in README and RELASE_NOTES files >>>> >>>> Added: >>>> geronimo/server/branches/2.1/RELEASE_NOTES-2.1.4-SNAPSHOT.txt >>>> - copied, changed from r691623, >>>> geronimo/server/branches/2.1/RELEASE_NOTES-2.1.4.txt >>>> Removed: >>>> geronimo/server/branches/2.1/RELEASE_NOTES-2.1.4.txt >>>> Modified: >>>> geronimo/server/branches/2.1/README.txt >>>> >>>> >>>> >>>> geronimo/server/branches/2.1/assemblies/geronimo-boilerplate-minimal/pom.xml >>>> >>>> Modified: geronimo/server/branches/2.1/README.txt >>>> URL: >>>> >>>> http://svn.apache.org/viewvc/geronimo/server/branches/2.1/README.txt?rev=691633&r1=691632&r2=691633&view=diff >>>> >>>> >>>> ============================================================================== >>>> --- geronimo/server/branches/2.1/README.txt (original) >>>> +++ geronimo/server/branches/2.1/README.txt Wed Sep 3 08:21:49 2008 >>>> @@ -1,5 +1,5 @@ >>>> ====================================================== >>>> -Apache Geronimo v2.1.4 (TBD) >>>> +Apache Geronimo [EMAIL PROTECTED]@ (TBD) >>>> http://geronimo.apache.org/ >>>> ------------------------------------------------------ >>>> @@ -9,7 +9,7 @@ >>>> Release Notes >>>> ====================== >>>> - Please read the RELEASE_NOTES-2.1.4.txt for a complete list of new >>>> features + Please read the [EMAIL PROTECTED]@.txt for a complete >>>> list >>>> of new features available in this release. >>>> Copied: geronimo/server/branches/2.1/RELEASE_NOTES-2.1.4-SNAPSHOT.txt >>>> (from r691623, geronimo/server/branches/2.1/RELEASE_NOTES-2.1.4.txt) >>>> URL: >>>> >>>> http://svn.apache.org/viewvc/geronimo/server/branches/2.1/RELEASE_NOTES-2.1.4-SNAPSHOT.txt?p2=geronimo/server/branches/2.1/RELEASE_NOTES-2.1.4-SNAPSHOT.txt&p1=geronimo/server/branches/2.1/RELEASE_NOTES-2.1.4.txt&r1=691623&r2=691633&rev=691633&view=diff >>>> >>>> >>>> ============================================================================== >>>> --- geronimo/server/branches/2.1/RELEASE_NOTES-2.1.4.txt (original) >>>> +++ geronimo/server/branches/2.1/RELEASE_NOTES-2.1.4-SNAPSHOT.txt Wed >>>> Sep >>>> 3 08:21:49 2008 >>>> @@ -1,4 +1,4 @@ >>>> -Release Notes -- Apache Geronimo -- Version 2.1.4 >>>> +Release Notes -- Apache Geronimo -- Version @VERSION@ >>>> Geronimo URLs >>>> @@ -58,7 +58,7 @@ >>>> through a sequence of steps and generates geronimo-web.xml >>>> automatically. >>>> -Geronimo 2.1.4 Issues Resolved >>>> +Geronimo @VERSION@ Issues Resolved >>>> ------------------------------ >>>> ** Bug >>>> TBD >>>> @@ -79,7 +79,7 @@ >>>> Distributions >>>> ------------- >>>> -Apache Geronimo v2.1.4 is available in five distributions so you can >>>> pick >>>> the +Apache Geronimo [EMAIL PROTECTED]@ is available in five distributions >>>> so >>>> you >>>> can pick the one that best fits your environment. >>>> The available distributions are as follows: >>>> >>>> Modified: >>>> >>>> geronimo/server/branches/2.1/assemblies/geronimo-boilerplate-minimal/pom.xml >>>> URL: >>>> >>>> http://svn.apache.org/viewvc/geronimo/server/branches/2.1/assemblies/geronimo-boilerplate-minimal/pom.xml?rev=691633&r1=691632&r2=691633&view=diff >>>> >>>> >>>> ============================================================================== >>>> --- >>>> >>>> geronimo/server/branches/2.1/assemblies/geronimo-boilerplate-minimal/pom.xml >>>> (original) >>>> +++ >>>> >>>> geronimo/server/branches/2.1/assemblies/geronimo-boilerplate-minimal/pom.xml >>>> Wed Sep 3 08:21:49 2008 >>>> @@ -301,8 +301,15 @@ >>>> <configuration> >>>> <tasks> >>>> <echo>Copying README, RELEASE_NOTES, and >>>> DISCLAIMER txt files ${project.basedir}/../.. to underlay - >>>> ${project.build.outputDirectory}/contents</echo> >>>> - <copy file >>>> ="${project.basedir}/../../README.txt" >>>> todir="${project.build.outputDirectory}/contents" failonerror="true" >>>> overwrite="true" /> >>>> - <copy file >>>> ="${project.basedir}/../../RELEASE_NOTES-2.1.4.txt" >>>> todir="${project.build.outputDirectory}/contents" failonerror="true" >>>> overwrite="true" /> >>>> + <copy >>>> todir="${project.build.outputDirectory}/contents" failonerror="true" >>>> overwrite="true" > >>>> + <fileset >>>> dir="${project.basedir}/../.."> >>>> + <include name="README.txt" /> >>>> + <include >>>> name="RELEASE_NOTES-${pom.version}.txt" /> >>>> + </fileset> >>>> + <filterset> >>>> + <filter token="VERSION" >>>> value="${pom.version}" /> >>>> + </filterset> >>>> + </copy> >>>> </tasks> >>>> </configuration> >>>> </execution> >>>> >>>> >>>> >>> >> > >
