You are viewing a plain text version of this content. The canonical link for it is here.
Posted to dev@synapse.apache.org by ant elder <an...@gmail.com> on 2006/11/14 19:46:39 UTC
Synapse distro naming
A comment you often see on ipmc reviews of incubating releases is that the
distributions should unpack into a top level directory which includes the
release number [1]. How about changing Synapse to do this, so for the
0.90release the distro binary distro would unzip into a directory
named
synapse-0.90 and the src distro into synapse-src-0.90?
There was a comment about one of our Tuscany releases saying the release
number should go before the '-incubating-', [2]. Thats maybe a maven2 thing,
does that also apply to maven v1?
The zip and jar names aren't so consistent right now either, theres
Apache-Synapse-Incubating-0.90.jar, extension_mediators.jar, nhttp.jar,
syanpse-0.90.mar. How about changing those to be
synapse-0.90-incubating.jar, synapse-extensions-0.90-incubating.jar,
synapse-nhttp-0.90-incubating.jar, synapse-0.90-incubating.mar. And for all
the distro zips name them similarly, eg synapse-0.90-incubating-bin.zip,
synapse-0.90-incubating-src.zip, synapse-extensions-0.90-incubating-bin.zipetc?
...ant
[1] http://www.mail-archive.com/general@incubator.apache.org/msg11280.html
[2]
http://mail-archives.apache.org/mod_mbox/ws-tuscany-dev/200606.mbox/%3c200606210759.49630.daniel.kulp@iona.com%3e
Re: Synapse distro naming
Posted by Paul Fremantle <pz...@gmail.com>.
+1 from me.
Paul
On 11/14/06, ant elder <an...@gmail.com> wrote:
> A comment you often see on ipmc reviews of incubating releases is that the
> distributions should unpack into a top level directory which includes the
> release number [1]. How about changing Synapse to do this, so for the 0.90
> release the distro binary distro would unzip into a directory named
> synapse-0.90 and the src distro into synapse-src-0.90?
>
> There was a comment about one of our Tuscany releases saying the release
> number should go before the '-incubating-', [2]. Thats maybe a maven2 thing,
> does that also apply to maven v1?
>
> The zip and jar names aren't so consistent right now either, theres
> Apache-Synapse-Incubating-0.90.jar,
> extension_mediators.jar, nhttp.jar, syanpse-0.90.mar. How about changing
> those to be
> synapse-0.90-incubating.jar ,
> synapse-extensions-0.90-incubating.jar,
> synapse-nhttp-0.90-incubating.jar,
> synapse-0.90-incubating.mar. And for all the distro zips name them
> similarly, eg synapse-0.90-incubating-bin.zip,
> synapse-0.90-incubating-src.zip ,
> synapse-extensions-0.90-incubating-bin.zip etc?
>
> ...ant
>
> [1]
> http://www.mail-archive.com/general@incubator.apache.org/msg11280.html
>
> [2]
> http://mail-archives.apache.org/mod_mbox/ws-tuscany-dev/200606.mbox/%3c200606210759.49630.daniel.kulp@iona.com%3e
>
--
Paul Fremantle
VP/Technology, WSO2 and OASIS WS-RX TC Co-chair
http://bloglines.com/blog/paulfremantle
paul@wso2.com
"Oxygenating the Web Service Platform", www.wso2.com
---------------------------------------------------------------------
To unsubscribe, e-mail: synapse-dev-unsubscribe@ws.apache.org
For additional commands, e-mail: synapse-dev-help@ws.apache.org
Re: Synapse distro naming
Posted by ant elder <an...@gmail.com>.
On 11/17/06, ant elder <an...@gmail.com> wrote:
<snip>
On 11/17/06, Asankha C. Perera <as...@wso2.com> wrote:
> >
> > Ant
> >
> > Please validate the below.. I am going through the RAT stuff.. and will
> > fix the licenses within the JAR files.. what about concatenating all
> > licenses into one file.. ? Would you be able to do that..
>
>
> Ok yes I'll do this.
>
Done, see:
https://svn.apache.org/repos/asf/incubator/synapse/trunk/java/src/main/release/LICENSE
https://svn.apache.org/repos/asf/incubator/synapse/trunk/java/src/main/release/NOTICE
I think those match whats required, but welcome anyone checking.
I've rerun the RAT tool on the distro's from the new mvn build, see:
http://people.apache.org/~antelder/synapse/. The bin distro is clean now,
just a few files not correctly picked up as txt on bin. Same with the src
distro except for download.cgi and the META-INF/services files, can you have
comments in those? probably doesn't matter as they're so small.
...ant
Re: Synapse distro naming
Posted by ant elder <an...@gmail.com>.
The distro's are starting to look pretty god to me. Some responses in line
below - i think we may have to include license headers in all files and
include the 'incubating' string in jar names.
...ant
On 11/17/06, Asankha C. Perera <as...@wso2.com> wrote:
>
> Ant
>
> Please validate the below.. I am going through the RAT stuff.. and will
> fix the licenses within the JAR files.. what about concatenating all
> licenses into one file.. ? Would you be able to do that..
Ok yes I'll do this.
also I do not
> intend to put an ASL license in all resource files (such as sample
> synapse.xml configs, xslts etc).. is this really required?
Unfortunately I think it is required in most files yes. The ASF policy is
here: http://www.apache.org/legal/src-headers.html#headers and there's a
further comment right at the bottom of that page. I think I do remember a
review comment on incubator general about if a file is completely trivial
you don't need a header (eg a test file containing just the word "test") but
otherwise the license header should always be included.
ant elder wrote:
> > A comment you often see on ipmc reviews of incubating releases is that
> > the distributions should unpack into a top level directory which
> > includes the release number [1]. How about changing Synapse to do
> > this, so for the 0.90 release the distro binary distro would unzip
> > into a directory named synapse-0.90 and the src distro into
> > synapse-src-0.90?
> Source Dist : synapse-0.90-SNAPSHOT-incubating-src.zip
> Unpacks to: synapse-0.90-SNAPSHOT-src\....
>
> Binary dist : synapse-0.90-SNAPSHOT-incubating-bin.zip
> Unpacks to: synapse-0.90-SNAPSHOT....
> >
> > There was a comment about one of our Tuscany releases saying the
> > release number should go before the '-incubating-', [2]. Thats maybe a
> > maven2 thing, does that also apply to maven v1?
> Done
> > The zip and jar names aren't so consistent right now either, theres
> > Apache-Synapse-Incubating-0.90.jar, extension_mediators.jar,
> > nhttp.jar, syanpse-0.90.mar. How about changing those to be
> > synapse-0.90-incubating.jar , synapse-extensions-0.90-incubating.jar,
> > synapse-nhttp-0.90-incubating.jar, synapse-0.90-incubating.mar. And
> > for all the distro zips name them similarly, eg
> > synapse-0.90-incubating-bin.zip, synapse-0.90-incubating-src.zip ,
> > synapse-extensions-0.90-incubating-bin.zip etc?
>
> I prefer to leave the "incubating" off JARs and MARs.. cause otherwise
> its difficult to set dependencies on these from other projects.. please
> advice
I think we only have to include the 'incubating' string if the artifact is
going to be publicly distributed. The src and binary distros are publicly
downloadable so they must include the 'incubating' string, right now the
Synapse jars and mars aren't distributed separately so they probably don't
need it. If we want to put the Synapse jars and mars in a public maven
repository then we do have to include "incubating" in the jar and mar name.
I'd like the Syanpse jars to go into a maven repository so we can use them
in things like Tuscany in which case they would need to include
'incubating'.
(that said, I can't find where this requirement is documented right now,
i'll keep looking but does anyone else know about this?)
synapse-core-0.90-SNAPSHOT.jar
> synapse-extensions-0.90-SNAPSHOT.jar
> synapse-samples-0.90-SNAPSHOT.jar
>
> synapse-0.90-SNAPSHOT.mar
>
>
> thanks
> asankha
>
> ---------------------------------------------------------------------
> To unsubscribe, e-mail: synapse-dev-unsubscribe@ws.apache.org
> For additional commands, e-mail: synapse-dev-help@ws.apache.org
>
>
Re: Synapse distro naming
Posted by "Asankha C. Perera" <as...@wso2.com>.
Ant
Please validate the below.. I am going through the RAT stuff.. and will
fix the licenses within the JAR files.. what about concatenating all
licenses into one file.. ? Would you be able to do that.. also I do not
intend to put an ASL license in all resource files (such as sample
synapse.xml configs, xslts etc).. is this really required?
ant elder wrote:
> A comment you often see on ipmc reviews of incubating releases is that
> the distributions should unpack into a top level directory which
> includes the release number [1]. How about changing Synapse to do
> this, so for the 0.90 release the distro binary distro would unzip
> into a directory named synapse-0.90 and the src distro into
> synapse-src-0.90?
Source Dist : synapse-0.90-SNAPSHOT-incubating-src.zip
Unpacks to: synapse-0.90-SNAPSHOT-src\....
Binary dist : synapse-0.90-SNAPSHOT-incubating-bin.zip
Unpacks to: synapse-0.90-SNAPSHOT....
>
> There was a comment about one of our Tuscany releases saying the
> release number should go before the '-incubating-', [2]. Thats maybe a
> maven2 thing, does that also apply to maven v1?
Done
> The zip and jar names aren't so consistent right now either, theres
> Apache-Synapse-Incubating-0.90.jar, extension_mediators.jar,
> nhttp.jar, syanpse-0.90.mar. How about changing those to be
> synapse-0.90-incubating.jar , synapse-extensions-0.90-incubating.jar,
> synapse-nhttp-0.90-incubating.jar, synapse-0.90-incubating.mar. And
> for all the distro zips name them similarly, eg
> synapse-0.90-incubating-bin.zip, synapse-0.90-incubating-src.zip ,
> synapse-extensions-0.90-incubating-bin.zip etc?
I prefer to leave the "incubating" off JARs and MARs.. cause otherwise
its difficult to set dependencies on these from other projects.. please
advice
synapse-core-0.90-SNAPSHOT.jar
synapse-extensions-0.90-SNAPSHOT.jar
synapse-samples-0.90-SNAPSHOT.jar
synapse-0.90-SNAPSHOT.mar
thanks
asankha
---------------------------------------------------------------------
To unsubscribe, e-mail: synapse-dev-unsubscribe@ws.apache.org
For additional commands, e-mail: synapse-dev-help@ws.apache.org
Re: Synapse distro naming
Posted by ant elder <an...@gmail.com>.
Hi Asankha, I can't get the m2 build to work, see the attached log. Its like
there's something missing, maybe something else you need to commit? If you
delete your local m2 repository does it build ok for you?
...ant
[INFO] Scanning for projects...
[INFO]
------------------------------------------------------------------------
[ERROR] FATAL ERROR
[INFO]
------------------------------------------------------------------------
[INFO] Failed to resolve artifact.
GroupId: org.apache.synapse
ArtifactId: Apache-Synapse-Incubating
Version: SNAPSHOT
Reason: Unable to download the artifact from any repository
org.apache.synapse:Apache-Synapse-Incubating:pom:SNAPSHOT
from the specified remote repositories:
central (http://repo1.maven.org/maven2)
[INFO]
------------------------------------------------------------------------
[INFO] Trace
org.apache.maven.reactor.MavenExecutionException: Cannot find parent:
org.apache.synapse:Apache-Synapse-Incubating for project:
null:synapse-core:jar:null
at org.apache.maven.DefaultMaven.getProjects(DefaultMaven.java:365)
at org.apache.maven.DefaultMaven.doExecute(DefaultMaven.java:278)
at org.apache.maven.DefaultMaven.execute(DefaultMaven.java:115)
at org.apache.maven.cli.MavenCli.main(MavenCli.java:256)
at sun.reflect.NativeMethodAccessorImpl.invoke0(Native Method)
at sun.reflect.NativeMethodAccessorImpl.invoke(
NativeMethodAccessorImpl.java:39)
at sun.reflect.DelegatingMethodAccessorImpl.invoke(
DelegatingMethodAccessorImpl.java:25)
at java.lang.reflect.Method.invoke(Method.java:585)
at org.codehaus.classworlds.Launcher.launchEnhanced(Launcher.java:315)
at org.codehaus.classworlds.Launcher.launch(Launcher.java:255)
at org.codehaus.classworlds.Launcher.mainWithExitCode(Launcher.java:430)
at org.codehaus.classworlds.Launcher.main(Launcher.java:375)
Caused by: org.apache.maven.project.ProjectBuildingException: Cannot find
parent: org.apache.synapse:Apache-Synapse-Incubating for project:
null:synapse-core:jar:null
at org.apache.maven.project.DefaultMavenProjectBuilder.assembleLineage(
DefaultMavenProjectBuilder.java:1161)
at org.apache.maven.project.DefaultMavenProjectBuilder.buildInternal(
DefaultMavenProjectBuilder.java:674)
at
org.apache.maven.project.DefaultMavenProjectBuilder.buildFromSourceFileInternal
(DefaultMavenProjectBuilder.java:416)
at org.apache.maven.project.DefaultMavenProjectBuilder.build(
DefaultMavenProjectBuilder.java:192)
at org.apache.maven.DefaultMaven.getProject(DefaultMaven.java:515)
at org.apache.maven.DefaultMaven.collectProjects(DefaultMaven.java:447)
at org.apache.maven.DefaultMaven.collectProjects(DefaultMaven.java:491)
at org.apache.maven.DefaultMaven.getProjects(DefaultMaven.java:351)
... 11 more
Caused by: org.apache.maven.project.ProjectBuildingException: POM '
org.apache.synapse:Apache-Synapse-Incubating' not found in repository:
Unable to download the artifact from any repository
org.apache.synapse:Apache-Synapse-Incubating:pom:SNAPSHOT
from the specified remote repositories:
central (http://repo1.maven.org/maven2)
at
org.apache.maven.project.DefaultMavenProjectBuilder.findModelFromRepository(
DefaultMavenProjectBuilder.java:513)
at org.apache.maven.project.DefaultMavenProjectBuilder.assembleLineage(
DefaultMavenProjectBuilder.java:1157)
... 18 more
Caused by: org.apache.maven.artifact.resolver.ArtifactNotFoundException:
Unable to download the artifact from any repository
org.apache.synapse:Apache-Synapse-Incubating:pom:SNAPSHOT
from the specified remote repositories:
central (http://repo1.maven.org/maven2)
at org.apache.maven.artifact.resolver.DefaultArtifactResolver.resolve(
DefaultArtifactResolver.java:136)
at org.apache.maven.artifact.resolver.DefaultArtifactResolver.resolve(
DefaultArtifactResolver.java:63)
at
org.apache.maven.project.DefaultMavenProjectBuilder.findModelFromRepository(
DefaultMavenProjectBuilder.java:467)
... 19 more
Caused by: org.apache.maven.wagon.ResourceDoesNotExistException: Unable to
download the artifact from any repository
at org.apache.maven.artifact.manager.DefaultWagonManager.getArtifact(
DefaultWagonManager.java:260)
at org.apache.maven.artifact.resolver.DefaultArtifactResolver.resolve(
DefaultArtifactResolver.java:124)
... 21 more
[INFO]
------------------------------------------------------------------------
[INFO] Total time: < 1 second
[INFO] Finished at: Wed Nov 15 08:53:15 GMT 2006
[INFO] Final Memory: 1M/2M
[INFO]
------------------------------------------------------------------------
On 11/14/06, ant elder <an...@gmail.com> wrote:
>
> On 11/14/06, Asankha C. Perera <as...@wso2.com> wrote:
> >
> > Ant
> >
> > As you may have noticed, I started to clean up the svn and build.. and
> > just now checked in a working base m2 build in parallel to the m1 build. (it
> > is much faster than m1.. would be great to check if you are able to run it
> > though)
> >
>
> Cool! I'll go try it out.
>
> ...ant
>
>
Re: Synapse distro naming
Posted by ant elder <an...@gmail.com>.
On 11/14/06, Asankha C. Perera <as...@wso2.com> wrote:
>
> Ant
>
> As you may have noticed, I started to clean up the svn and build.. and
> just now checked in a working base m2 build in parallel to the m1 build. (it
> is much faster than m1.. would be great to check if you are able to run it
> though)
>
Cool! I'll go try it out.
...ant
Re: Synapse distro naming
Posted by Sanjiva Weerawarana <sa...@opensource.lk>.
On Tue, 2006-11-14 at 22:59 -0700, Phil Steitz wrote:
> > No that's not right IMO: The src distro should just extra into
> > synapse-0.90/src/*. That's how pretty much every package works
>
> Not really, at least not at apache. Struts, tomcat, (most of) jakarta
> commons, for example, all still upack to separate -src top levels. I
Hmmm. JDK for instance doesn't .. u unpack the src distro and it neatly
fits into the tree under src/. Same for docs.
OK clearly there's more than one way to skin this cat. I prefer my way
but won't hold my breadth for it!
> am curious where this has been discussed and what the pros and cons
> are. As a developer, keeping the distros separate makes release
> checking a tad easier and as a user it is a little more convenient if
> you want to maintain a working binary install while hacking on a
> separate source distro.
That's certainly true. I'm all for having a different src distro; the
only issue is whether it should extract within the bin dist or into a
separate directory.
> In any case, embedding the release number in both artifact names and
> unpack directories is a best practice. I know there are also special
> rules about the "incubator" word ;-). If you do decide to go the
> separate -src route, I think it is better to have -src last, i.e.,
> synapse-0.90-src, rather than synapse-src-0.90. My 0.90 c.
If we're going to unpack to different directories then I'm +1 for
synapse-incubating-0.90 and synapse-incubating-0.90-src.
Sanjiva.
---------------------------------------------------------------------
To unsubscribe, e-mail: synapse-dev-unsubscribe@ws.apache.org
For additional commands, e-mail: synapse-dev-help@ws.apache.org
Re: Synapse distro naming
Posted by ant elder <an...@gmail.com>.
On 11/15/06, Phil Steitz <ph...@gmail.com> wrote:
>
> On 11/14/06, Sanjiva Weerawarana <sa...@opensource.lk> wrote:
> > On Wed, 2006-11-15 at 00:56 +0530, Asankha C. Perera wrote:
> > > Ant
> > >
> > > As you may have noticed, I started to clean up the svn and build.. and
> > > just now checked in a working base m2 build in parallel to the m1
> > > build. (it is much faster than m1.. would be great to check if you are
> > > able to run it though)
> > >
> > > As Paul has also agreed, I will make the suggested improvements as
> > > follows:
> > >
> > > Synapse distribution
> > > * Binary - synapse-0.90-incubating.bin.zip
> > > - will extract to synapse-0.90
> > >
> > > * Source - synapse-0.90-incubating.src.zip
> > > - will extract to synapse-src-0.90
> >
> > No that's not right IMO: The src distro should just extra into
> > synapse-0.90/src/*. That's how pretty much every package works
>
> Not really, at least not at apache. Struts, tomcat, (most of) jakarta
> commons, for example, all still upack to separate -src top levels. I
> am curious where this has been discussed and what the pros and cons
> are. As a developer, keeping the distros separate makes release
> checking a tad easier and as a user it is a little more convenient if
> you want to maintain a working binary install while hacking on a
> separate source distro.
>
> In any case, embedding the release number in both artifact names and
> unpack directories is a best practice. I know there are also special
> rules about the "incubator" word ;-). If you do decide to go the
> separate -src route, I think it is better to have -src last, i.e.,
> synapse-0.90-src, rather than synapse-src-0.90. My 0.90 c.
>
> Phil
This comes up quite often on the incubator general mailing list, here's a
couple of emails from a recent thread [1] [2]. There doesn't seem to be a
whole lot of consensus on a best practice approach yet, AFAICT robert
burrell donkin likes the way I've proposed above, and as he does a lot of
the reviewing of the incubator releases it seemed easiest to try to keep him
happy :)
The main complaint is when the distros aren't consistent or just unpack into
the current directory or don't include the release number, so its not going
to be a problem to change to the way Sanjiva suggests and we could say we're
being consistent with the WS project approach.
...ant
[1] http://marc.theaimsgroup.com/?l=incubator-general&m=116066602215579&w=2
[2] http://marc.theaimsgroup.com/?l=incubator-general&m=116068487126150&w=2
Re: Synapse distro naming
Posted by Phil Steitz <ph...@gmail.com>.
On 11/14/06, Sanjiva Weerawarana <sa...@opensource.lk> wrote:
> On Wed, 2006-11-15 at 00:56 +0530, Asankha C. Perera wrote:
> > Ant
> >
> > As you may have noticed, I started to clean up the svn and build.. and
> > just now checked in a working base m2 build in parallel to the m1
> > build. (it is much faster than m1.. would be great to check if you are
> > able to run it though)
> >
> > As Paul has also agreed, I will make the suggested improvements as
> > follows:
> >
> > Synapse distribution
> > * Binary - synapse-0.90-incubating.bin.zip
> > - will extract to synapse-0.90
> >
> > * Source - synapse-0.90-incubating.src.zip
> > - will extract to synapse-src-0.90
>
> No that's not right IMO: The src distro should just extra into
> synapse-0.90/src/*. That's how pretty much every package works
Not really, at least not at apache. Struts, tomcat, (most of) jakarta
commons, for example, all still upack to separate -src top levels. I
am curious where this has been discussed and what the pros and cons
are. As a developer, keeping the distros separate makes release
checking a tad easier and as a user it is a little more convenient if
you want to maintain a working binary install while hacking on a
separate source distro.
In any case, embedding the release number in both artifact names and
unpack directories is a best practice. I know there are also special
rules about the "incubator" word ;-). If you do decide to go the
separate -src route, I think it is better to have -src last, i.e.,
synapse-0.90-src, rather than synapse-src-0.90. My 0.90 c.
Phil
> and we've
> just fixed up the axis2 distro to work like that too. Even the docs
> distro is the same, expands into synapse-0.90/docs. (Yeah I know we
> don't have a separate distro yet but if we do in the future .. axis2
> ships it separately because its quite large by itself. Although I have
> to agree its questionable to leave out all docs from the binary distro;
> worth revisiting for 1.2.)
>
> Sanjiva.
>
>
>
> ---------------------------------------------------------------------
> To unsubscribe, e-mail: synapse-dev-unsubscribe@ws.apache.org
> For additional commands, e-mail: synapse-dev-help@ws.apache.org
>
>
---------------------------------------------------------------------
To unsubscribe, e-mail: synapse-dev-unsubscribe@ws.apache.org
For additional commands, e-mail: synapse-dev-help@ws.apache.org
Re: Synapse distro naming
Posted by Sanjiva Weerawarana <sa...@opensource.lk>.
On Wed, 2006-11-15 at 00:56 +0530, Asankha C. Perera wrote:
> Ant
>
> As you may have noticed, I started to clean up the svn and build.. and
> just now checked in a working base m2 build in parallel to the m1
> build. (it is much faster than m1.. would be great to check if you are
> able to run it though)
>
> As Paul has also agreed, I will make the suggested improvements as
> follows:
>
> Synapse distribution
> * Binary - synapse-0.90-incubating.bin.zip
> - will extract to synapse-0.90
>
> * Source - synapse-0.90-incubating.src.zip
> - will extract to synapse-src-0.90
No that's not right IMO: The src distro should just extra into
synapse-0.90/src/*. That's how pretty much every package works and we've
just fixed up the axis2 distro to work like that too. Even the docs
distro is the same, expands into synapse-0.90/docs. (Yeah I know we
don't have a separate distro yet but if we do in the future .. axis2
ships it separately because its quite large by itself. Although I have
to agree its questionable to leave out all docs from the binary distro;
worth revisiting for 1.2.)
Sanjiva.
---------------------------------------------------------------------
To unsubscribe, e-mail: synapse-dev-unsubscribe@ws.apache.org
For additional commands, e-mail: synapse-dev-help@ws.apache.org