Edit tck-dist to include all data previously requried in platform TCK

tck-dist/README.md

@@ -1,7 +1,51 @@
-# Concurrency Readme
+# Concurrency TCK Distribution
+
+## Generate Documentation
+
+The Concurrency TCK has condensed the documentation down to a single asciidoc file
+under `src/main/asciidoc/concurrency-tck-reference-guide.adoc`.  
+
+This change will help with maintainability, readability, and distribution of the documentation to users. 
+
+This project will output two different distributions of the TCK documentation. 
+One is a PDF and the other is a static HTML page. 
+To re-generate the TCK documentation run the following maven task: 
+
+```sh
+cd tck-dist
+mvn generate-resources
+```
+
+The output documentation files will be located under `/tck-dist/target/generated-docs/`
+
+## Documentation auto-refresh
+
+When making edits to the documentation it is helpful to view the asciidoc and HTML output page together.
+To accomplish this goal run the following maven task: 
+
+```sh
+cd tck-dist
+mvn asciidoctor:http asciidoctor:auto-refresh
+```
+
+Then point your browser to `http://localhost:2000/concurrency-tck-reference-guide-<TCK_VERSION>.html`
+
+Whenever edits are made to the source document, this page will be updated. 
+
+## Generate Distribution
+
+This project is configured to output the distributed archive for the Concurrency TCK.
+To generate this archive run the following maven task: 
+
+```sh
+cd tck-dist
+mvn package
+```
+
+The distributed archive will be output to `/tck-dist/target/concurrency-tck-<TCK_VERSION>-dist.zip`
+
+## Links
+
+- [AsciiDoc User Guide](http://asciidoc.org/userguide.html)
+- [Asciidoctor quick reference](http://asciidoctor.org/docs/asciidoc-syntax-quick-reference)
 
-This bundle contains the Jakarta Concurrency TCK. The contents of this bundle are:
-- This README.md
-- docs/README.md - the TCK user guide
-- LICENSE - the EFTL license terms
-- artifacts - the TCK tests jar and sample script to install into a local maven repo

tck-dist/pom.xml

@@ -18,14 +18,15 @@
 -->
 <project xmlns="http://maven.apache.org/POM/4.0.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd">
     <modelVersion>4.0.0</modelVersion>
+
     <parent>
 	    <groupId>jakarta.enterprise.concurrent</groupId>
     	<artifactId>jakarta.enterprise.concurrent.parent</artifactId>
       <version>3.0.0-SNAPSHOT</version>
+
     </parent>
-    <groupId>jakarta.enterprise.concurrent</groupId>
-    <artifactId>concurrent-tck-dist</artifactId>
-    <version>3.0.0-SNAPSHOT</version>
+
+    <artifactId>jakarta.enterprise.concurrent-tck-dist</artifactId>
     <packaging>pom</packaging>
 
     <name>Jakarta Concurrency TCK Distribution</name>
@@ -48,8 +49,15 @@
 
         <jakarta.concurrent.version.ga>3.0.0</jakarta.concurrent.version.ga>
         <jakarta.concurrent.version.dev>${project.version}</jakarta.concurrent.version.dev>
+
+        <maven.site.skip>true</maven.site.skip>
+        <asciidoctor.maven.plugin.version>2.2.2</asciidoctor.maven.plugin.version>
+        <asciidoctorj.version>2.5.3</asciidoctorj.version>
+        <asciidoctorj.pdf.version>1.6.2</asciidoctorj.pdf.version>
+        <jruby.version>9.2.20.1</jruby.version>
 
     </properties>
+
     <dependencies>
         <dependency>
           <groupId>jakarta.enterprise.concurrent</groupId>
@@ -63,8 +71,67 @@
           <type>pom</type>
         </dependency>
     </dependencies>
+
     <build>
       <plugins>
+        <!-- Aciidoctor will create the html and pdf distributions of the user-guide -->
+        <plugin>
+          <groupId>org.asciidoctor</groupId>
+          <artifactId>asciidoctor-maven-plugin</artifactId>
+          <version>${asciidoctor.maven.plugin.version}</version>
+          <dependencies>
+            <dependency>
+                <groupId>org.jruby</groupId>
+                <artifactId>jruby-complete</artifactId>
+                <version>${jruby.version}</version>
+            </dependency>
+            <dependency>
+                <groupId>org.asciidoctor</groupId>
+                <artifactId>asciidoctorj</artifactId>
+                <version>${asciidoctorj.version}</version>
+            </dependency>
+            <dependency>
+                <groupId>org.asciidoctor</groupId>
+                <artifactId>asciidoctorj-pdf</artifactId>
+                <version>${asciidoctorj.pdf.version}</version>
+            </dependency>
+          </dependencies>
+          <executions>
+            <execution>
+                <id>asciidoc-to-html</id>
+                <phase>generate-resources</phase>
+                <goals>
+                    <goal>process-asciidoc</goal>
+                </goals>
+                <configuration>
+                    <backend>html5</backend>
+                    <outputFile>
+                        ${project.build.directory}/generated-docs/concurrency-tck-reference-guide-${project.version}.html
+                    </outputFile>
+                </configuration>
+            </execution>
+            <execution>
+                <id>asciidoc-to-pdf</id>
+                <phase>generate-resources</phase>
+                <goals>
+                    <goal>process-asciidoc</goal>
+                </goals>
+                <configuration>
+                    <backend>pdf</backend>
+                    <outputFile>
+                        ${project.build.directory}/generated-docs/concurrency-tck-reference-guide-${project.version}.pdf
+                    </outputFile>
+                </configuration>
+            </execution>
+          </executions>
+          <configuration>
+              <toc>left</toc>
+              <sourceDocumentName>concurrency-tck-reference-guide.adoc</sourceDocumentName>
+              <sourceHighlighter>coderay</sourceHighlighter>
+              <skip>${maven.adoc.skip}</skip>
+          </configuration>
+        </plugin>
+        <!-- Assembly plugin to collect everything into a single distribution -->
         <plugin>
           <artifactId>maven-assembly-plugin</artifactId>
           <executions>

tck-dist/src/main/artifacts/exceptions.txt

@@ -0,0 +1,22 @@
+ #
+ # Copyright (c) 2022 Contributors to the Eclipse Foundation
+ #
+ # This program and the accompanying materials are made available under the
+ # terms of the Eclipse Public License v. 2.0, which is available at
+ # http://www.eclipse.org/legal/epl-2.0.
+ #
+ # This Source Code may also be made available under the following Secondary
+ # Licenses when the conditions for such availability set forth in the
+ # Eclipse Public License v. 2.0 are satisfied: GNU General Public License,
+ # version 2 with the GNU Classpath Exception, which is available at
+ # https://www.gnu.org/software/classpath/license.html.
+ #
+ # SPDX-License-Identifier: EPL-2.0 OR GPL-2.0 WITH Classpath-exception-2.0
+ #
+
+ ####################
+ # This file contains a list of tests that have been voted to be exempt from the requirement
+ # of implementations to pass to claim compatibility with the Jakarta Concurrency Specification. 
+ # Format: <package-name>#<test-method-name>
+ # Example: ee.jakarta.tck.concurrent.api.AbortedException#AbortedExceptionNoArgTest
+ ####################