Include offline docs in distribution zip

Author: zhangt2333

README.md

@@ -76,7 +76,7 @@ In Proceedings of the 32nd ACM SIGSOFT International Symposium on Software Testi
 ## How to Obtain Runnable Tai-e?
 
 The recommended way is to download the distribution ZIP from [GitHub Releases](https://github.com/pascal-lab/Tai-e/releases).
-The ZIP contains Tai-e, all runtime dependencies, and startup scripts for Windows, Linux, and macOS.
+The ZIP contains Tai-e, all runtime dependencies, offline documentation, and startup scripts for Windows, Linux, and macOS.
 
 Alternatively, you might build the latest Tai-e yourself from the source code. This can be simply accomplished via Gradle (be sure that Java 17 (or higher version) is available on your system):
 

build.gradle.kts

@@ -59,12 +59,34 @@ application {
     applicationName = projectArtifactId
 }
 
+val apiDocs = tasks.named("javadoc")
+val docsProject = project(":docs")
+
 distributions {
     main {
         distributionBaseName.set(projectArtifactId)
         contents {
             from(files("COPYING", "COPYING.LESSER",
                 "README.md", "CHANGELOG.md", "CITATION.bib"))
+            from(apiDocs) {
+                into("docs/api")
+            }
+        }
+    }
+}
+
+docsProject.plugins.withId("org.asciidoctor.jvm.convert") {
+    val referenceDocs = docsProject.files(
+        docsProject.layout.buildDirectory.dir("docs/asciidoc")
+    ).builtBy(docsProject.tasks.named("asciidoctor"))
+
+    distributions {
+        main {
+            contents {
+                from(referenceDocs) {
+                    into("docs/reference")
+                }
+            }
         }
     }
 }

release-tests/src/test/java/pascal/taie/release/DistributionTests.java

@@ -30,6 +30,7 @@
 import java.util.zip.ZipEntry;
 import java.util.zip.ZipInputStream;
 
+import static org.junit.jupiter.api.Assertions.assertFalse;
 import static org.junit.jupiter.api.Assertions.assertNotNull;
 import static org.junit.jupiter.api.Assertions.assertTrue;
 
@@ -43,6 +44,9 @@ CliRunner createRunner(File workingDir) throws IOException {
                 + "distribution ZIP");
         Path distributionDir = workingDir.toPath().resolve("distribution");
         extractZip(Path.of(distributionZipPath), distributionDir);
+        assertDistributionFile(distributionDir, "docs/reference/en/index.html");
+        assertNoDistributionFile(distributionDir, "docs/reference/index.html");
+        assertDistributionFile(distributionDir, "docs/api/index.html");
         Path executable = findExecutable(distributionDir);
         if (!isWindows()) {
             assertTrue(executable.toFile().setExecutable(true)
@@ -73,6 +77,28 @@ private static void extractZip(Path zipPath, Path outputDir) throws IOException
         }
     }
 
+    private static void assertDistributionFile(
+            Path distributionDir, String relativePath) throws IOException {
+        assertTrue(containsDistributionFile(distributionDir, relativePath),
+                "Distribution ZIP should contain " + relativePath);
+    }
+
+    private static void assertNoDistributionFile(
+            Path distributionDir, String relativePath) throws IOException {
+        assertFalse(containsDistributionFile(distributionDir, relativePath),
+                "Distribution ZIP should not contain " + relativePath);
+    }
+
+    private static boolean containsDistributionFile(
+            Path distributionDir, String relativePath) throws IOException {
+        Path expectedPath = Path.of(relativePath);
+        try (var files = Files.walk(distributionDir)) {
+            return files
+                    .filter(Files::isRegularFile)
+                    .anyMatch(path -> path.endsWith(expectedPath));
+        }
+    }
+
     private static Path findExecutable(Path distributionDir) throws IOException {
         String executableName = isWindows() ? "tai-e.bat" : "tai-e";
         try (var files = Files.walk(distributionDir)) {