You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@isis.apache.org by da...@apache.org on 2022/09/25 11:37:42 UTC
[isis] branch master updated (f9e1ddf2e1 -> 1c888cdfe3)
This is an automated email from the ASF dual-hosted git repository.
danhaywood pushed a change to branch master
in repository https://gitbox.apache.org/repos/asf/isis.git
from f9e1ddf2e1 ISIS-2965: update release docs is all
new 1c88195747 ISIS-2965: updates rat config for excluded files
new 5afe6e3fc2 ISIS-2965: update release docs is all
new 1c888cdfe3 ISIS-2965: updates supplemental-models.xml per missing license info
The 3 revisions listed above as "new" are entirely new to this
repository and will be described in separate emails. The revisions
listed as "add" were already present in the repository and have only
been added to this reference.
Summary of changes:
.../modules/ROOT/pages/cutting-a-release.adoc | 65 ++++++++--------------
bom/pom.xml | 2 +-
.../src/main/resources/supplemental-models.xml | 2 +-
3 files changed, 25 insertions(+), 44 deletions(-)
[isis] 02/03: ISIS-2965: update release docs is all
Posted by da...@apache.org.
This is an automated email from the ASF dual-hosted git repository.
danhaywood pushed a commit to branch master
in repository https://gitbox.apache.org/repos/asf/isis.git
commit 5afe6e3fc28ae8f2a963e47c744b0ed96b14d100
Author: Dan Haywood <da...@haywood-associates.co.uk>
AuthorDate: Sun Sep 25 12:00:05 2022 +0100
ISIS-2965: update release docs is all
---
.../modules/ROOT/pages/cutting-a-release.adoc | 62 ++++++++--------------
1 file changed, 21 insertions(+), 41 deletions(-)
diff --git a/antora/components/comguide/modules/ROOT/pages/cutting-a-release.adoc b/antora/components/comguide/modules/ROOT/pages/cutting-a-release.adoc
index 4aec42fe4c..dac8bd8279 100644
--- a/antora/components/comguide/modules/ROOT/pages/cutting-a-release.adoc
+++ b/antora/components/comguide/modules/ROOT/pages/cutting-a-release.adoc
@@ -63,6 +63,7 @@ git pull --ff-only
The Apache Release Audit Tool `RAT` (from the http://creadur.apache.org[Apache Creadur] project) checks for missing license header files.
The parent `pom.xml` of each releasable module specifies the RAT Maven plugin, with a number of custom exclusions.
+We run the tool runs over all submodules, including non-released modules.
To run the RAT tool, use:
[source,bash,subs="attributes+"]
@@ -70,25 +71,27 @@ To run the RAT tool, use:
----
pushd bom
mvn -Dapache-release clean
-mvn -Dapache-release org.apache.rat:apache-rat-plugin:check -D rat.numUnapprovedLicenses=1000
+mvn -Dapache-release org.apache.rat:apache-rat-plugin:check -D rat.numUnapprovedLicenses=1000 # <.>
popd
-for a in `/bin/find . -name rat.txt -print`; do grep '!???' $a; done > /tmp/rat-qn.txt
-for a in `/bin/find . -name rat.txt -print`; do grep '!AL' $a; done > /tmp/rat-al.txt
+for a in `/bin/find . -name rat.txt -print`; do grep '!???' $a; done > /tmp/rat-qn.txt # <.>
+for a in `/bin/find . -name rat.txt -print`; do grep '!AL' $a; done > /tmp/rat-al.txt # <2>
+
+cat /tmp/rat-qn.txt
+cat /tmp/rat-al.txt
----
-NOTE: the parent `pom.xml` in each of these locations has the `apache-rat-plugin` appropriately configured.
+<.> The command writes out a `target\rat.txt` for each submodule. missing license notes are indicated using the key `!???`.
-This script runs over all submodules, including non-released modules.
+<.> Collates all the errors.
-The command writes out a `target\rat.txt` for each submodule. missing license notes are indicated using the key `!???`.
-The `for` command collates all the errors.
-Investigate and fix any reported violations, typically by either:
+Inspect the contents of the two `/tmp/rat-*.txt` files and fix any reported violations, typically by either:
* adding genuinely missing license headers from Java (or other) source files, or
* updating the `<excludes>` element for the `apache-rat-plugin` plugin to ignore test files, log files and any other non-source code files
-* also look to remove any stale `<exclude>` entries
+
+Also, look to remove any stale `<exclude>` entries
Once you've fixed all issues, run the script again to confirm that all license violations have been fixed.
@@ -100,44 +103,21 @@ Without appropriate additional configuration, this would result in the generated
Fortunately, Maven allows the missing information to be provided by configuring the `maven-remote-resources-plugin`.
This is stored in the `src/main/appended-resources/supplemental-models.xml` file, relative to the root of each releasable module.
-It's first necessary to have built the framework locally at least once.
-
-* switch to the `bom` directory:
-+
[source,bash,subs="attributes+"]
----
pushd bom
-----
-
-* build the framework (ok to skip tests):
-+
-[source,bash,subs="attributes+"]
-----
-mvn -Dgithub clean install -DskipTests
-----
-+
-NB: the `-Dgithub` activates the "github" profile which references the exact same ``<module>``s as the official "apache-release" profile.
-
-* Capture the missing license information using:
-+
-[source,bash,subs="attributes+"]
-----
-mvn -Dgithub license:download-licenses
-----
-
-* Switch back to the root directory:
-+
-[source,bash,subs="attributes+"]
-----
+mvn -Dgithub clean install -DskipTests # <.>
+mvn -Dgithub license:download-licenses # <.>
popd
-----
-
-* Report on the missing license information using:
-+
-[source,bash,subs="attributes+"]
-----
groovy scripts/checkmissinglicenses.groovy
----
+<.> builds the framework.
++
+It's necessary to have built the framework locally at least once (ok to skip tests).
++
+The `-Dgithub` activates the "github" profile which references the exact same ``<module>``s as the official "apache-release" profile.
+<.> Captures the missing license information
+<.> Reports on the missing license information using:
The Maven plugin creates a `license.xml` file in the `target/generated-resources` directory of each module.
[isis] 01/03: ISIS-2965: updates rat config for excluded files
Posted by da...@apache.org.
This is an automated email from the ASF dual-hosted git repository.
danhaywood pushed a commit to branch master
in repository https://gitbox.apache.org/repos/asf/isis.git
commit 1c8819574748aa35ea9e2abb41e16ba5f8c6e9e7
Author: Dan Haywood <da...@haywood-associates.co.uk>
AuthorDate: Sun Sep 25 11:52:20 2022 +0100
ISIS-2965: updates rat config for excluded files
---
bom/pom.xml | 2 +-
1 file changed, 1 insertion(+), 1 deletion(-)
diff --git a/bom/pom.xml b/bom/pom.xml
index 9bb71982f1..f5ab76eebb 100644
--- a/bom/pom.xml
+++ b/bom/pom.xml
@@ -727,7 +727,7 @@ It is therefore a copy of org.apache:apache, with customisations clearly identif
<exclude>**/jquery.zclip.js</exclude>
<exclude>**/simple-sidebar.css</exclude>
- <exclude>**/bootstrap-growl.js</exclude>
+ <exclude>**/isis-bootstrap-growl.js</exclude>
<exclude>**/moment.js</exclude>
<exclude>**/prism*.js</exclude>
<exclude>**/prism*.css</exclude>
[isis] 03/03: ISIS-2965: updates supplemental-models.xml per missing license info
Posted by da...@apache.org.
This is an automated email from the ASF dual-hosted git repository.
danhaywood pushed a commit to branch master
in repository https://gitbox.apache.org/repos/asf/isis.git
commit 1c888cdfe3b2ce8a5e239aa0dce41456c5f81490
Author: Dan Haywood <da...@haywood-associates.co.uk>
AuthorDate: Sun Sep 25 12:37:29 2022 +0100
ISIS-2965: updates supplemental-models.xml per missing license info
---
.../comguide/modules/ROOT/pages/cutting-a-release.adoc | 15 ++++++++-------
.../src/main/resources/supplemental-models.xml | 2 +-
2 files changed, 9 insertions(+), 8 deletions(-)
diff --git a/antora/components/comguide/modules/ROOT/pages/cutting-a-release.adoc b/antora/components/comguide/modules/ROOT/pages/cutting-a-release.adoc
index dac8bd8279..d001908ff5 100644
--- a/antora/components/comguide/modules/ROOT/pages/cutting-a-release.adoc
+++ b/antora/components/comguide/modules/ROOT/pages/cutting-a-release.adoc
@@ -106,8 +106,8 @@ This is stored in the `src/main/appended-resources/supplemental-models.xml` file
[source,bash,subs="attributes+"]
----
pushd bom
-mvn -Dgithub clean install -DskipTests # <.>
-mvn -Dgithub license:download-licenses # <.>
+mvn -Dgithub clean install -T1C -DskipTests # <.>
+mvn -Dgithub license:download-licenses # <.>
popd
groovy scripts/checkmissinglicenses.groovy
----
@@ -116,12 +116,13 @@ groovy scripts/checkmissinglicenses.groovy
It's necessary to have built the framework locally at least once (ok to skip tests).
+
The `-Dgithub` activates the "github" profile which references the exact same ``<module>``s as the official "apache-release" profile.
-<.> Captures the missing license information
-<.> Reports on the missing license information using:
-
-
+<.> Captures the missing license information.
++
The Maven plugin creates a `license.xml` file in the `target/generated-resources` directory of each module.
-The script then searches for these `licenses.xml` files, and compares them against the contents of the `supplemental-models.xml` file.
+
+<.> Reports on the missing license information
++
+The script searches for these `licenses.xml` files, and compares them against the contents of the `supplemental-models.xml` file.
For example, the output could be something like:
diff --git a/supplemental-model/src/main/resources/supplemental-models.xml b/supplemental-model/src/main/resources/supplemental-models.xml
index 23844cee66..f0b7b08cf3 100644
--- a/supplemental-model/src/main/resources/supplemental-models.xml
+++ b/supplemental-model/src/main/resources/supplemental-models.xml
@@ -121,7 +121,7 @@
<project>
<groupId>org.webjars.npm</groupId>
<artifactId>pdfjs-dist</artifactId>
- <version>2.14.305</version>
+ <version>2.16.105</version>
<name>PDF.js</name>
<licenses>
<license>