[tomee-tck] 01/05: DESIGN.adoc so we can remember how this is put together

[db...@apache.org]

This is an automated email from the ASF dual-hosted git repository.

dblevins pushed a commit to branch jakartaee9-tck
in repository https://gitbox.apache.org/repos/asf/tomee-tck.git

commit 7fd0b42fc7c6df8185ad7361cee03a16adbd0ff9
Author: David Blevins <da...@gmail.com>
AuthorDate: Tue Jun 16 17:05:12 2020 -0700

    DESIGN.adoc so we can remember how this is put together
---
 DESIGN.adoc | 21 +++++++++++++++++++++
 1 file changed, 21 insertions(+)

diff --git a/DESIGN.adoc b/DESIGN.adoc
new file mode 100644
index 0000000..c040577
--- /dev/null
+++ b/DESIGN.adoc
@@ -0,0 +1,21 @@
+# Design Notes to Help Maintainers
+
+# Compiling against libs in the TCK
+
+There are several dependencies that do not point to Maven Central, but actually to jars inside the TCK distribution itself.  These dependencies use `<scope>system</scope>` and `<systemPath>` as follows to point to individual jars:
+
+[source,xml]
+----
+<dependency>
+  <groupId>com.sun.javaee.tck</groupId>
+  <artifactId>tsharness</artifactId>
+  <version>${jakartaee.tck.version}</version>
+  <scope>system</scope>
+  <systemPath>${jakartaee.cts.home}/lib/tsharness.jar</systemPath>
+</dependency>
+----
+
+In the above the most critical setting is `<systemPath>` which must point to an actual jar on your system.  The `<groupId>`, `<artifactId>` and `<version>` are invented and could actually be anything.
+
+As the TCK evolves jars may be renamed, removed or added and it may be necessary to adjust these dependencies.
+