#50: improve documentation

Signed-off-by: Lukas Jungmann <lukas.jungmann@oracle.com>
eclipse-ee4j · Jan 19, 2023 · d05372a · d05372a
1 parent bb9bb7f
commit d05372a
Show file tree

Hide file tree

Showing 2 changed files with 16 additions and 3 deletions.
diff --git a/.github/workflows/web.yml b/.github/workflows/web.yml
@@ -53,10 +53,12 @@ jobs:
           echo Building javadoc for Angus Mail version: $ANGUS_MAIL_VERSION
           export ACTIVATION_API_VERSION=`mvn -B -U -C org.apache.maven.plugins:maven-dependency-plugin:3.4.0:tree -f doc/pom.xml -Dincludes=\*:jakarta.activation-api:\* -Dangus-mail.version=$ANGUS_MAIL_VERSION | grep activation-api | cut -d ':' -f 4 | tr -d '[:space:]'`
           export MAIL_API_VERSION=`mvn -B -U -C org.apache.maven.plugins:maven-dependency-plugin:3.4.0:tree -f doc/pom.xml -Dincludes=\*:jakarta.mail-api:\* -Dangus-mail.version=$ANGUS_MAIL_VERSION | grep mail-api | cut -d ':' -f 4 | tr -d '[:space:]'`
+          export ANGUS_ACTIVATION_VERSION=`curl -s https://repo1.maven.org/maven2/org/eclipse/angus/all/$ANGUS_MAIL_VERSION/all-$ANGUS_MAIL_VERSION.pom | grep -o -m 1 "<angus.activation.version>[[:digit:]]\.[[:digit:]]\.[[:digit:]]</angus.activation.version" | cut -f 2 -d ">" | cut -f 1 -d "<" | tr -d '[:space:]'`
           echo Activation API version: $ACTIVATION_API_VERSION
+          echo Angus Activation version: $ANGUS_ACTIVATION_VERSION
           echo Mail API version: $MAIL_API_VERSION
-          echo mvn -B -U -C -V -Pstaging clean install -f doc/pom.xml -Dangus-mail.version=$ANGUS_MAIL_VERSION -Dmail-api.version=$MAIL_API_VERSION -Dactivation-api.version=$ACTIVATION_API_VERSION
-          mvn -B -U -C -V -Pstaging clean install -f doc/pom.xml -Dangus-mail.version=$ANGUS_MAIL_VERSION -Dmail-api.version=$MAIL_API_VERSION -Dactivation-api.version=$ACTIVATION_API_VERSION
+          echo mvn -B -U -C -V -Pstaging clean install -f doc/pom.xml -Dangus-mail.version=$ANGUS_MAIL_VERSION -Dmail-api.version=$MAIL_API_VERSION -Dangus-activation.version=$ANGUS_ACTIVATION_VERSION -Dactivation-api.version=$ACTIVATION_API_VERSION
+          mvn -B -U -C -V -Pstaging clean install -f doc/pom.xml -Dangus-mail.version=$ANGUS_MAIL_VERSION -Dmail-api.version=$MAIL_API_VERSION -Dangus-activation.version=$ANGUS_ACTIVATION_VERSION -Dactivation-api.version=$ACTIVATION_API_VERSION
           rm -rf ./www/docs || true
           mkdir -p ./www/docs
           cp -Rfv doc/target/site/* ./www/

diff --git a/doc/src/main/resources/README.md b/doc/src/main/resources/README.md
@@ -66,7 +66,9 @@ The latest release of Angus Mail is ${angus-mail.version}.
 
 The following table provides easy access to the latest release. Most
 people will only need the main Angus Mail implementation in the
-angus-mail.jar file.
+`angus-mail.jar` and `jakarta.mail-api.jar` files together
+with [the Angus Activation](https://eclipse-ee4j.github.io/angus-activation/)
+on the module path or on the class path.
 
 | Item                                                                                                                                     | Description                                                                            |
 |:-----------------------------------------------------------------------------------------------------------------------------------------|:---------------------------------------------------------------------------------------|
@@ -142,6 +144,15 @@ Finally, for fine-grained control over the providers in use, following jar files
 
 <br/>
 
+[Angus Activation](https://eclipse-ee4j.github.io/angus-activation/) provides following jar files:
+
+| jar file                                                                                                                                                                              | module name                   | groupId            | artifactId             | Description                                                                 |
+|:--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|:------------------------------|:-------------------|:-----------------------|:----------------------------------------------------------------------------|
+| [jakarta.activation-api.jar](https://repo1.maven.org/maven2/jakarta/activation/jakarta.activation-api/${activation-api.version}/jakarta.activation-api-${activation-api.version}.jar) | jakarta.activation            | jakarta.activation | jakarta.activation-api | The Jakarta Activation API definitions only, suitable for compiling against |
+| [angus-activation.jar](https://repo1.maven.org/maven2/org/eclipse/angus/angus-activation/${angus-activation.version}/angus-activation-${angus-activation.version}.jar)                | com.sun.activation.registries | org.eclipse.angus  | angus-activation       | The Angus Activation runtime                                                |
+
+<br/>
+
 # <a name="API_Documentation"></a>API Documentation
 
 The Jakarta Mail API is defined through the