[hibernate-dev] Hibernate Commons project

[Yoann Rodiere]

Everything you said seems to make sense to me, so +1.
We can see later whether we agree on the other common projects we could add
(checkstyle rules, test utils, ...), but I think there won't be many
arguments *against* them as long as there is no transitive dependency to
these projects for end users. It's mostly about how we work internally,
after all.

About the specifics:

== The groupId

To me it seems to make perfect sense to move hibernate-commons-annotations
to the same repo, but I can understand it'll cause some trouble to
developers. At the very least we could just rename
org.hibernate:hibernate-commons-annotations to
org.hibernate.commons:hibernate-commons-annotations, so that we'll be
consistent with the other 6.x groupId renamings. As for moving code between
repos, we can always see about that later: it won't impact end users.

== The license

On the license side, I think we can only license our common projects under
Apache License 2, because one cannot include LGPL work within an ASL2 work.
So using LGPL would prevent us from using the projects in HV... probably.
Source: http://www.apache.org/legal/resolved.html#category-x
> The LGPL is ineligible primarily due to the restrictions it places on
larger works, violating the third license criterion.


Yoann Rodière <yoann at hibernate.org>
Hibernate NoORM Team

On 30 January 2017 at 11:23, Guillaume Smet <guillaume.smet at gmail.com>
wrote:

> Hi,
>
> So, as discussed at the F2F, I set up an hibernate-commons project.
>
> Currently, it's here https://github.com/gsmet/hibernate-commons, waiting
> for everyone to agree on the name, the license, the purpose and so on.
>
> We would like to make quick progress on it as it's blocking for the
> migration of Search and OGM to the new AsciiDoctor output (we are still
> using Docbook as the final output for these projects). It would be nice if
> we could move them to this output for Search 5.7 and OGM 5.1 which are
> planned for the coming weeks.
>
> Basically the idea behind this repo is to centralize things useful to all
> (or several) Hibernate projects:
> - an AsciiDoctor theme
> - testing utilities we would like to share for all the Hibernate projects
> - (still to be decided as not that obvious) utilities we would like to
> share for the NoORM projects
>
> Things that should be discussed:
>
> == The groupId
>
> I used hibernate-commons as it seemed like an obvious groupId. The fact is
> that we already have hibernate-commons-annotations here.
>
> Thoughts?
>
> == The license
>
> Most of our projects are LGPL licensed except for HV which is Apache 2
> licensed. Which license should we choose?
>
> == The AsciiDoctor theme
>
> So the theme I put in is slightly different from the one from ORM:
> - the top banner is white instead of black. The black banner was a bit too
> aggressive to my taste;
> - I was very light on customizing the HTML output as I would really like us
> to not spend time on maintaining it. So it's basically the default output
> whereas ORM has customized the color of the titles of the links and several
> other things. I think the default output is really nice and we can keep it
> as is;
> - I customized the PDF output a bit more as there were problems with the
> default output. I think it's pretty good now.
>
> Here is the current output for Search:
> - HTML: http://docs.jboss.org/hibernate/beta/html_single/
> - PDF:
> http://docs.jboss.org/hibernate/beta/pdf/hibernate_search_reference.pdf
>
> -> note that if you want to use a specific theme for specific purposes, it
> would still be possible. It's a base you can configure with your own CSS
> and such.
>
> Thoughts?
>
> --
> Guillaume
> _______________________________________________
> hibernate-dev mailing list
> hibernate-dev at lists.jboss.org
> https://lists.jboss.org/mailman/listinfo/hibernate-dev
>