From 453b37fb9bfbcc26bd333f035d563db55b6fea79 Mon Sep 17 00:00:00 2001 From: Julian Ladisch Date: Tue, 8 Oct 2024 00:09:41 +0200 Subject: [PATCH 1/5] Use ASF 3rd Party License Policy for module evaluation To current third party dependency criterium is not actionable: > Third party dependencies use an Apache 2.0 compatible license This creates some difficulties for module developers and module evaluators and requires verbose explanations that can easily been avoided. Change to what we usually use: > Inclusion of third party dependencies complies with [ASF 3rd Party License Policy](https://apache.org/legal/resolved.html) > * org.z3950.zing:cql-java is allowed, even if it is LGPL-2.1-only The exemption of cql-java is needed because Spring Way modules frequently use folio-spring-cql that uses cql2pgjson that uses cql-java: * https://github.com/search?q=org%3Afolio-org+folio-spring-cql+language%3A%22Maven+POM%22&type=code&l=Maven+POM * https://github.com/folio-org/folio-spring-support/blob/v8.1.2/folio-spring-cql/pom.xml#L35 * https://github.com/folio-org/raml-module-builder/blob/v35.2.2/cql2pgjson/pom.xml#L58 This criterium can be changed as soon as better third party requirements get proposed. --- MODULE_ACCEPTANCE_CRITERIA.MD | 3 ++- MODULE_EVALUATION_TEMPLATE.MD | 3 ++- 2 files changed, 4 insertions(+), 2 deletions(-) diff --git a/MODULE_ACCEPTANCE_CRITERIA.MD b/MODULE_ACCEPTANCE_CRITERIA.MD index ad91702..76ea018 100644 --- a/MODULE_ACCEPTANCE_CRITERIA.MD +++ b/MODULE_ACCEPTANCE_CRITERIA.MD @@ -45,7 +45,8 @@ Please see [Before Development](MODULE_EVALUATION_TEMPLATE#before-development) f * _This is not applicable to libraries_ * Module descriptor MUST include interface requirements for all consumed APIs (3, 5) * _This is not applicable to libraries_ -* Third party dependencies use an Apache 2.0 compatible license (2) +* Inclusion of third party dependencies complies with [ASF 3rd Party License Policy](https://apache.org/legal/resolved.html) (2) + * org.z3950.zing:cql-java is allowed, even if it is LGPL-2.1-only * Installation documentation is included (11) * -_note: read more at https://github.com/folio-org/mod-search/blob/master/README.md_ * _This is not applicable to libraries_ diff --git a/MODULE_EVALUATION_TEMPLATE.MD b/MODULE_EVALUATION_TEMPLATE.MD index 7770834..a3ce703 100644 --- a/MODULE_EVALUATION_TEMPLATE.MD +++ b/MODULE_EVALUATION_TEMPLATE.MD @@ -20,7 +20,8 @@ When performing a technical evaluation of a module, create a copy of this docume * [ ] Uses Apache 2.0 license * [ ] Module build MUST produce a valid module descriptor * [ ] Module descriptor MUST include interface requirements for all consumed APIs -* [ ] Third party dependencies use an Apache 2.0 compatible license +* [ ] Inclusion of third party dependencies complies with [ASF 3rd Party License Policy](https://apache.org/legal/resolved.html) + * org.z3950.zing:cql-java is allowed, even if it is LGPL-2.1-only * [ ] Installation documentation is included * -_note: read more at https://github.com/folio-org/mod-search/blob/master/README.md_ * [ ] Personal data form is completed, accurate, and provided as `PERSONAL_DATA_DISCLOSURE.md` file From 6fe63ab1dedf2bbf52d20010f68f4a7281b57b89 Mon Sep 17 00:00:00 2001 From: Julian Ladisch Date: Tue, 8 Oct 2024 14:53:10 +0200 Subject: [PATCH 2/5] Bump version --- MODULE_ACCEPTANCE_CRITERIA.MD | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/MODULE_ACCEPTANCE_CRITERIA.MD b/MODULE_ACCEPTANCE_CRITERIA.MD index 76ea018..a09be14 100644 --- a/MODULE_ACCEPTANCE_CRITERIA.MD +++ b/MODULE_ACCEPTANCE_CRITERIA.MD @@ -1,6 +1,6 @@ # FOLIO Module Acceptance Values and Criteria -## version 2.0 (ratified 2022-06-10) +## version 2.1 (ratified 20??-??-??) # Overview The Technical Council (TC) has defined a process for technical evaluation of modules for inclusion in a FOLIO release. This document outlines the high level values and specific criteria used when evaluating modules as part of this process. The distinction between values and criteria is as follows: From 15b2d2fefda3760ae8a74c4528235a86fed1b196 Mon Sep 17 00:00:00 2001 From: Julian Ladisch Date: Mon, 28 Oct 2024 16:45:30 +0100 Subject: [PATCH 3/5] Uses README for Category B Appropriately Labelled Condition --- MODULE_ACCEPTANCE_CRITERIA.MD | 1 + MODULE_EVALUATION_TEMPLATE.MD | 1 + 2 files changed, 2 insertions(+) diff --git a/MODULE_ACCEPTANCE_CRITERIA.MD b/MODULE_ACCEPTANCE_CRITERIA.MD index a09be14..eefa3c4 100644 --- a/MODULE_ACCEPTANCE_CRITERIA.MD +++ b/MODULE_ACCEPTANCE_CRITERIA.MD @@ -46,6 +46,7 @@ Please see [Before Development](MODULE_EVALUATION_TEMPLATE#before-development) f * Module descriptor MUST include interface requirements for all consumed APIs (3, 5) * _This is not applicable to libraries_ * Inclusion of third party dependencies complies with [ASF 3rd Party License Policy](https://apache.org/legal/resolved.html) (2) + * Uses README for [Category B Appropriately Labelled Condition](https://apache.org/legal/resolved.html#appropriately-labelled-condition) * org.z3950.zing:cql-java is allowed, even if it is LGPL-2.1-only * Installation documentation is included (11) * -_note: read more at https://github.com/folio-org/mod-search/blob/master/README.md_ diff --git a/MODULE_EVALUATION_TEMPLATE.MD b/MODULE_EVALUATION_TEMPLATE.MD index a3ce703..7bf46f3 100644 --- a/MODULE_EVALUATION_TEMPLATE.MD +++ b/MODULE_EVALUATION_TEMPLATE.MD @@ -21,6 +21,7 @@ When performing a technical evaluation of a module, create a copy of this docume * [ ] Module build MUST produce a valid module descriptor * [ ] Module descriptor MUST include interface requirements for all consumed APIs * [ ] Inclusion of third party dependencies complies with [ASF 3rd Party License Policy](https://apache.org/legal/resolved.html) + * Uses README for [Category B Appropriately Labelled Condition](https://apache.org/legal/resolved.html#appropriately-labelled-condition) * org.z3950.zing:cql-java is allowed, even if it is LGPL-2.1-only * [ ] Installation documentation is included * -_note: read more at https://github.com/folio-org/mod-search/blob/master/README.md_ From 5d05f0d799c4ee791d34fb90c823e30b27a39dc5 Mon Sep 17 00:00:00 2001 From: Julian Ladisch Date: Tue, 26 Nov 2024 14:44:47 +0100 Subject: [PATCH 4/5] Allow marc4j with LGPL-2.1-or-later --- MODULE_ACCEPTANCE_CRITERIA.MD | 1 + MODULE_EVALUATION_TEMPLATE.MD | 1 + 2 files changed, 2 insertions(+) diff --git a/MODULE_ACCEPTANCE_CRITERIA.MD b/MODULE_ACCEPTANCE_CRITERIA.MD index eefa3c4..23275a3 100644 --- a/MODULE_ACCEPTANCE_CRITERIA.MD +++ b/MODULE_ACCEPTANCE_CRITERIA.MD @@ -48,6 +48,7 @@ Please see [Before Development](MODULE_EVALUATION_TEMPLATE#before-development) f * Inclusion of third party dependencies complies with [ASF 3rd Party License Policy](https://apache.org/legal/resolved.html) (2) * Uses README for [Category B Appropriately Labelled Condition](https://apache.org/legal/resolved.html#appropriately-labelled-condition) * org.z3950.zing:cql-java is allowed, even if it is LGPL-2.1-only + * org.marc4j:marc4j is allowed, even if it is LGPL-2.1-or-later * Installation documentation is included (11) * -_note: read more at https://github.com/folio-org/mod-search/blob/master/README.md_ * _This is not applicable to libraries_ diff --git a/MODULE_EVALUATION_TEMPLATE.MD b/MODULE_EVALUATION_TEMPLATE.MD index 7bf46f3..cc2dc2f 100644 --- a/MODULE_EVALUATION_TEMPLATE.MD +++ b/MODULE_EVALUATION_TEMPLATE.MD @@ -23,6 +23,7 @@ When performing a technical evaluation of a module, create a copy of this docume * [ ] Inclusion of third party dependencies complies with [ASF 3rd Party License Policy](https://apache.org/legal/resolved.html) * Uses README for [Category B Appropriately Labelled Condition](https://apache.org/legal/resolved.html#appropriately-labelled-condition) * org.z3950.zing:cql-java is allowed, even if it is LGPL-2.1-only + * org.marc4j:marc4j is allowed, even if it is LGPL-2.1-or-later * [ ] Installation documentation is included * -_note: read more at https://github.com/folio-org/mod-search/blob/master/README.md_ * [ ] Personal data form is completed, accurate, and provided as `PERSONAL_DATA_DISCLOSURE.md` file From 310fb78811a576cf2ecf7c33b99ed09045a3b2c4 Mon Sep 17 00:00:00 2001 From: Julian Ladisch Date: Mon, 16 Dec 2024 17:54:48 +0100 Subject: [PATCH 5/5] add hibernate as exception, add label requirement --- MODULE_ACCEPTANCE_CRITERIA.MD | 5 +++-- MODULE_EVALUATION_TEMPLATE.MD | 5 +++-- 2 files changed, 6 insertions(+), 4 deletions(-) diff --git a/MODULE_ACCEPTANCE_CRITERIA.MD b/MODULE_ACCEPTANCE_CRITERIA.MD index 23275a3..b90b100 100644 --- a/MODULE_ACCEPTANCE_CRITERIA.MD +++ b/MODULE_ACCEPTANCE_CRITERIA.MD @@ -47,8 +47,9 @@ Please see [Before Development](MODULE_EVALUATION_TEMPLATE#before-development) f * _This is not applicable to libraries_ * Inclusion of third party dependencies complies with [ASF 3rd Party License Policy](https://apache.org/legal/resolved.html) (2) * Uses README for [Category B Appropriately Labelled Condition](https://apache.org/legal/resolved.html#appropriately-labelled-condition) - * org.z3950.zing:cql-java is allowed, even if it is LGPL-2.1-only - * org.marc4j:marc4j is allowed, even if it is LGPL-2.1-or-later + * org.z3950.zing:cql-java is allowed if appropriately labelled, even if it is LGPL-2.1-only + * org.marc4j:marc4j is allowed if appropriately labelled, even if it is LGPL-2.1-or-later + * org.hibernate.* is allowed if appropriately labelled, even if it is LGPL-2.1-or-later * Installation documentation is included (11) * -_note: read more at https://github.com/folio-org/mod-search/blob/master/README.md_ * _This is not applicable to libraries_ diff --git a/MODULE_EVALUATION_TEMPLATE.MD b/MODULE_EVALUATION_TEMPLATE.MD index cc2dc2f..dd5fb51 100644 --- a/MODULE_EVALUATION_TEMPLATE.MD +++ b/MODULE_EVALUATION_TEMPLATE.MD @@ -22,8 +22,9 @@ When performing a technical evaluation of a module, create a copy of this docume * [ ] Module descriptor MUST include interface requirements for all consumed APIs * [ ] Inclusion of third party dependencies complies with [ASF 3rd Party License Policy](https://apache.org/legal/resolved.html) * Uses README for [Category B Appropriately Labelled Condition](https://apache.org/legal/resolved.html#appropriately-labelled-condition) - * org.z3950.zing:cql-java is allowed, even if it is LGPL-2.1-only - * org.marc4j:marc4j is allowed, even if it is LGPL-2.1-or-later + * org.z3950.zing:cql-java is allowed if appropriately labelled, even if it is LGPL-2.1-only + * org.marc4j:marc4j is allowed if appropriately labelled, even if it is LGPL-2.1-or-later + * org.hibernate.* is allowed if appropriately labelled, even if it is LGPL-2.1-or-later * [ ] Installation documentation is included * -_note: read more at https://github.com/folio-org/mod-search/blob/master/README.md_ * [ ] Personal data form is completed, accurate, and provided as `PERSONAL_DATA_DISCLOSURE.md` file