You are viewing a plain text version of this content. The canonical link for it is here.
Posted to dev@hc.apache.org by Oleg Kalnichevski <ol...@apache.org> on 2010/10/27 22:11:21 UTC
Maven plugin for automatic NOTICE and LICENSE resource generation;
was Re: NOTICE and LICENCE file annoyances
Folks,
I have the first, very simple, but already quite useful, version of the
maven plugin for automatic NOTICE and LICENSE resource generation.
The plugin can traverse the project hierarchy upwards and pick up NOTICE
and LICENSE files at the level they are defined. That is, different
modules within the same project can have different licenses / notice. If
undefined on the current project level, resources of the parent project
will be used.
Please note the plugin does not use keywords expansion when generating
NOTICE files. It simply strips away the first two lines and re-generates
them based on parameters in the pom descriptor. This way the source
NOTICE file remains complete and fully readable even when copied with
the source distribution
You can find the plugin code here:
http://svn.apache.org/repos/asf/httpcomponents/maven-notice-plugin/trunk/
I also created a branch in the HttpClient project to test the plugin. I
personally think the project metadata looks cleaner and conciser with
all NOTICE and LICENSE specific stuff gone.
Please have a look
http://svn.apache.org/repos/asf/httpcomponents/httpclient/branches/notice-plugin-test/
And here comes the main question
Do we need a formal release vote in order to publish the plugin to the
official ASF repository, even though it is not going to be distributed
as a source tarball (official ASF release)?
Oleg
On Fri, 2010-10-22 at 13:28 +0100, sebb wrote:
> On 22 October 2010 12:09, Oleg Kalnichevski <ol...@apache.org> wrote:
> > On Fri, 2010-10-22 at 16:22 +0530, Asankha C. Perera wrote:
> >> Thanks for the explanation Oleg..
> >>
> >> In this case I vote for option (2). This is a simple file that will
> >> hardly change with releases..
> >>
> >
> > NOTICE files are not release specific but they need to be updated on a
> > yearly basis at the very least. Moreover, if we ever need to have more
> > stuff in NOTICE such as attribution clauses required by some licenses,
> > we would have to do that in a good dozen places.
>
> Strictly speaking, attribution clauses should go in the NOTICE file
> for the modules that use them only.
> So for example if cache needed a NOTICE entry, that would go in the
> cache NOTICE file and the overall NOTICE file only.
>
> > Basically NOTICE files suck. So, some kind of an automated process would
> > help make them suck less.
>
> IMO the problem is not with the NOTICE files, it is with Maven.
> Maven makes a lot of things easy, but some things difficult or impossible.
>
> > Oleg
> >
> >
> >
> > ---------------------------------------------------------------------
> > To unsubscribe, e-mail: dev-unsubscribe@hc.apache.org
> > For additional commands, e-mail: dev-help@hc.apache.org
> >
> >
>
> ---------------------------------------------------------------------
> To unsubscribe, e-mail: dev-unsubscribe@hc.apache.org
> For additional commands, e-mail: dev-help@hc.apache.org
>
---------------------------------------------------------------------
To unsubscribe, e-mail: dev-unsubscribe@hc.apache.org
For additional commands, e-mail: dev-help@hc.apache.org
Re: [ATTN] Deployment of maven plugin for automatic NOTICE and
LICENSE resource generation
Posted by sebb <se...@gmail.com>.
On 1 November 2010 22:49, Oleg Kalnichevski <ol...@apache.org> wrote:
> On Wed, 2010-10-27 at 22:11 +0200, Oleg Kalnichevski wrote:
>> Folks,
>>
>> I have the first, very simple, but already quite useful, version of the
>> maven plugin for automatic NOTICE and LICENSE resource generation.
>>
>> The plugin can traverse the project hierarchy upwards and pick up NOTICE
>> and LICENSE files at the level they are defined. That is, different
>> modules within the same project can have different licenses / notice. If
>> undefined on the current project level, resources of the parent project
>> will be used.
>>
>> Please note the plugin does not use keywords expansion when generating
>> NOTICE files. It simply strips away the first two lines and re-generates
>> them based on parameters in the pom descriptor. This way the source
>> NOTICE file remains complete and fully readable even when copied with
>> the source distribution
>>
>> You can find the plugin code here:
>>
>> http://svn.apache.org/repos/asf/httpcomponents/maven-notice-plugin/trunk/
>>
>> I also created a branch in the HttpClient project to test the plugin. I
>> personally think the project metadata looks cleaner and conciser with
>> all NOTICE and LICENSE specific stuff gone.
>>
>> Please have a look
>>
>> http://svn.apache.org/repos/asf/httpcomponents/httpclient/branches/notice-plugin-test/
>>
>> And here comes the main question
>>
>> Do we need a formal release vote in order to publish the plugin to the
>> official ASF repository, even though it is not going to be distributed
>> as a source tarball (official ASF release)?
>>
>
> Folks
>
> If no one responds with an objection, I assume I can proceed with
> deploying the maven plugin to the repository _without_ a formal release
> vote.
>
> Please respond if you see a problem with that.
I know that some projects don't think it's necessary to include
binaries in votes, but in those cases they do still vote on the source
used to create the binaries.
I don't think it's wise to release the binary without a formal vote.
If there is a problem, the RM is personally responsible.
> Oleg
>
>
> ---------------------------------------------------------------------
> To unsubscribe, e-mail: dev-unsubscribe@hc.apache.org
> For additional commands, e-mail: dev-help@hc.apache.org
>
>
---------------------------------------------------------------------
To unsubscribe, e-mail: dev-unsubscribe@hc.apache.org
For additional commands, e-mail: dev-help@hc.apache.org
[ATTN] Deployment of maven plugin for automatic NOTICE and LICENSE
resource generation
Posted by Oleg Kalnichevski <ol...@apache.org>.
On Wed, 2010-10-27 at 22:11 +0200, Oleg Kalnichevski wrote:
> Folks,
>
> I have the first, very simple, but already quite useful, version of the
> maven plugin for automatic NOTICE and LICENSE resource generation.
>
> The plugin can traverse the project hierarchy upwards and pick up NOTICE
> and LICENSE files at the level they are defined. That is, different
> modules within the same project can have different licenses / notice. If
> undefined on the current project level, resources of the parent project
> will be used.
>
> Please note the plugin does not use keywords expansion when generating
> NOTICE files. It simply strips away the first two lines and re-generates
> them based on parameters in the pom descriptor. This way the source
> NOTICE file remains complete and fully readable even when copied with
> the source distribution
>
> You can find the plugin code here:
>
> http://svn.apache.org/repos/asf/httpcomponents/maven-notice-plugin/trunk/
>
> I also created a branch in the HttpClient project to test the plugin. I
> personally think the project metadata looks cleaner and conciser with
> all NOTICE and LICENSE specific stuff gone.
>
> Please have a look
>
> http://svn.apache.org/repos/asf/httpcomponents/httpclient/branches/notice-plugin-test/
>
> And here comes the main question
>
> Do we need a formal release vote in order to publish the plugin to the
> official ASF repository, even though it is not going to be distributed
> as a source tarball (official ASF release)?
>
Folks
If no one responds with an objection, I assume I can proceed with
deploying the maven plugin to the repository _without_ a formal release
vote.
Please respond if you see a problem with that.
Oleg
---------------------------------------------------------------------
To unsubscribe, e-mail: dev-unsubscribe@hc.apache.org
For additional commands, e-mail: dev-help@hc.apache.org