Add javadocs/ktdocs + scripts to autogenerate them (#410)

restatedev · Jun 11, 2024 · fb8b225 · fb8b225
1 parent 6ca5ac2
commit fb8b225
Show file tree

Hide file tree

Showing 964 changed files with 185,101 additions and 26 deletions.
diff --git a/.github/workflows/pre-release.yml b/.github/workflows/pre-release.yml
@@ -45,6 +45,16 @@ jobs:
         env:
           GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
 
+      # We need java and gradle for the javadocs
+      - uses: actions/setup-java@v4
+        if: ${{ inputs.sdkJavaVersion != '' }}
+        with:
+          distribution: 'temurin'
+          java-version: '21'
+      - name: Setup Gradle
+        if: ${{ inputs.sdkJavaVersion != '' }}
+        uses: gradle/actions/setup-gradle@v3
+
       - name: Run the runtime generate script
         if: ${{ inputs.restateVersion != '' }}
         run: |
@@ -95,35 +105,37 @@ jobs:
       - name: Compile TypeScript code snippets
         run: npm install --prefix code_snippets/ts && npm run build --prefix code_snippets/ts
 
-      # Setup Java
-      - uses: actions/setup-java@v3
-        with:
-          distribution: 'temurin'
-          java-version: '21'
-
       # Upgrade Java code snippets if new version is provided
       - name: Find and replace restateVersion in build.gradle.kts for Java code snippets
-        if: github.event.inputs.sdkJavaVersion != ''
+        if: ${{ inputs.sdkJavaVersion != '' }}
         run: sed -i 's/val restateVersion = "[0-9A-Z.-]*"/val restateVersion = "${{ inputs.sdkJavaVersion }}"/' code_snippets/java/build.gradle.kts
-
-      # Check Java code snippets
-      - name: Test Java code snippets
-        uses: gradle/gradle-build-action@v2
-        with:
-          arguments: check
-          build-root-directory: code_snippets/java
-
       # Upgrade Kotlin code snippets if new version is provided
       - name: Find and replace restateVersion in build.gradle.kts for Kotlin code snippets
-        if: github.event.inputs.sdkJavaVersion != ''
+        if: ${{ inputs.sdkJavaVersion != '' }}
         run: sed -i 's/val restateVersion = "[0-9A-Z.-]*"/val restateVersion = "${{ inputs.sdkJavaVersion }}"/' code_snippets/kotlin/build.gradle.kts
 
+      # Check Java code snippets
+      - name: Test Java code snippets
+        if: ${{ inputs.sdkJavaVersion != '' }}
+        run: gradle -p code_snippets/java check
+
       # Check Kotlin code snippets
       - name: Test Kotlin code snippets
-        uses: gradle/gradle-build-action@v2
+        if: ${{ inputs.sdkJavaVersion != '' }}
+        run: gradle -p code_snippets/kotlin check
+
+      # Checkout SDK java for the javadocs/ktdocs
+      - name: Checkout SDK-Java
+        uses: actions/checkout@v3
+        if: ${{ inputs.sdkJavaVersion != '' }}
         with:
-          arguments: check
-          build-root-directory: code_snippets/kotlin
+          repository: restatedev/sdk-java
+          ref: v${{ inputs.sdkJavaVersion }}
+          path: temp-sdk-java
+      - name: Run the runtime generate script
+        if: ${{ inputs.sdkJavaVersion != '' }}
+        run: |
+          ./tools/build_sdk_java_docs.sh temp-sdk-java
 
       - name: Create Pull Request
         uses: peter-evans/create-pull-request@v5
@@ -133,4 +145,6 @@ jobs:
           add-paths: |
             restate.config.json
             static/schemas/*
+            static/javadocs/*
+            static/ktdocs/*
             docs/references/*
diff --git a/docusaurus.config.js b/docusaurus.config.js
@@ -161,11 +161,7 @@ const config = {
               {
                 label: "GitHub",
                 href: "https://github.com/restatedev",
-              },
-              {
-                label: "JavaDocs",
-                href: "https://javadoc.io/doc/dev.restate",
-              },
+              }
             ],
           },
         ],

diff --git a/sidebars.js b/sidebars.js
@@ -40,8 +40,13 @@ const sidebars = {
     {type: 'category', label: 'REFERENCES', items: [
         {
           type: 'link',
-          label: 'Java Docs',
-          href: 'https://javadoc.io/doc/dev.restate',
+          label: 'Java docs',
+          href: 'pathname:///javadocs/index.html',
+        },
+        {
+          type: 'link',
+          label: 'Kotlin docs',
+          href: 'pathname:///ktdocs/index.html',
         },
         {type: 'autogenerated', dirName: 'references'},
       ]},

diff --git a/static/javadocs/allclasses-index.html b/static/javadocs/allclasses-index.html
diff --git a/static/javadocs/allpackages-index.html b/static/javadocs/allpackages-index.html
@@ -0,0 +1,114 @@
+<!DOCTYPE HTML>
+<html lang="en">
+<head>
+<!-- Generated by javadoc (17) -->
+<title>All Packages (Restate SDK-Java documentation)</title>
+<meta name="viewport" content="width=device-width, initial-scale=1">
+<meta http-equiv="Content-Type" content="text/html; charset=utf-8">
+<meta name="description" content="package index">
+<meta name="generator" content="javadoc/AllPackagesIndexWriter">
+<link rel="stylesheet" type="text/css" href="stylesheet.css" title="Style">
+<link rel="stylesheet" type="text/css" href="script-dir/jquery-ui.min.css" title="Style">
+<link rel="stylesheet" type="text/css" href="jquery-ui.overrides.css" title="Style">
+<script type="text/javascript" src="script.js"></script>
+<script type="text/javascript" src="script-dir/jquery-3.6.1.min.js"></script>
+<script type="text/javascript" src="script-dir/jquery-ui.min.js"></script>
+</head>
+<body class="all-packages-index-page">
+<script type="text/javascript">var pathtoroot = "./";
+loadScripts(document, 'script');</script>
+<noscript>
+<div>JavaScript is disabled on your browser.</div>
+</noscript>
+<div class="flex-box">
+<header role="banner" class="flex-header">
+<nav role="navigation">
+<!-- ========= START OF TOP NAVBAR ======= -->
+<div class="top-nav" id="navbar-top">
+<div class="skip-nav"><a href="#skip-navbar-top" title="Skip navigation links">Skip navigation links</a></div>
+<ul id="navbar-top-firstrow" class="nav-list" title="Navigation">
+<li><a href="index.html">Overview</a></li>
+<li>Package</li>
+<li>Class</li>
+<li><a href="overview-tree.html">Tree</a></li>
+<li><a href="deprecated-list.html">Deprecated</a></li>
+<li><a href="index-all.html">Index</a></li>
+<li><a href="help-doc.html#all-packages">Help</a></li>
+</ul>
+</div>
+<div class="sub-nav">
+<div class="nav-list-search"><label for="search-input">SEARCH:</label>
+<input type="text" id="search-input" value="search" disabled="disabled">
+<input type="reset" id="reset-button" value="reset" disabled="disabled">
+</div>
+</div>
+<!-- ========= END OF TOP NAVBAR ========= -->
+<span class="skip-nav" id="skip-navbar-top"></span></nav>
+</header>
+<div class="flex-content">
+<main role="main">
+<div class="header">
+<h1 title="All&amp;nbsp;Packages" class="title">All&nbsp;Packages</h1>
+</div>
+<div class="caption"><span>Package Summary</span></div>
+<div class="summary-table two-column-summary">
+<div class="table-header col-first">Package</div>
+<div class="table-header col-last">Description</div>
+<div class="col-first even-row-color"><a href="dev/restate/admin/api/package-summary.html">dev.restate.admin.api</a></div>
+<div class="col-last even-row-color">&nbsp;</div>
+<div class="col-first odd-row-color"><a href="dev/restate/admin/client/package-summary.html">dev.restate.admin.client</a></div>
+<div class="col-last odd-row-color">&nbsp;</div>
+<div class="col-first even-row-color"><a href="dev/restate/admin/model/package-summary.html">dev.restate.admin.model</a></div>
+<div class="col-last even-row-color">&nbsp;</div>
+<div class="col-first odd-row-color"><a href="dev/restate/generated/sdk/java/package-summary.html">dev.restate.generated.sdk.java</a></div>
+<div class="col-last odd-row-color">&nbsp;</div>
+<div class="col-first even-row-color"><a href="dev/restate/generated/service/discovery/package-summary.html">dev.restate.generated.service.discovery</a></div>
+<div class="col-last even-row-color">&nbsp;</div>
+<div class="col-first odd-row-color"><a href="dev/restate/generated/service/protocol/package-summary.html">dev.restate.generated.service.protocol</a></div>
+<div class="col-last odd-row-color">&nbsp;</div>
+<div class="col-first even-row-color"><a href="dev/restate/sdk/package-summary.html">dev.restate.sdk</a></div>
+<div class="col-last even-row-color">&nbsp;</div>
+<div class="col-first odd-row-color"><a href="dev/restate/sdk/annotation/package-summary.html">dev.restate.sdk.annotation</a></div>
+<div class="col-last odd-row-color">&nbsp;</div>
+<div class="col-first even-row-color"><a href="dev/restate/sdk/auth/package-summary.html">dev.restate.sdk.auth</a></div>
+<div class="col-last even-row-color">&nbsp;</div>
+<div class="col-first odd-row-color"><a href="dev/restate/sdk/auth/signing/package-summary.html">dev.restate.sdk.auth.signing</a></div>
+<div class="col-last odd-row-color">&nbsp;</div>
+<div class="col-first even-row-color"><a href="dev/restate/sdk/client/package-summary.html">dev.restate.sdk.client</a></div>
+<div class="col-last even-row-color">&nbsp;</div>
+<div class="col-first odd-row-color"><a href="dev/restate/sdk/common/package-summary.html">dev.restate.sdk.common</a></div>
+<div class="col-last odd-row-color">&nbsp;</div>
+<div class="col-first even-row-color"><a href="dev/restate/sdk/common/function/package-summary.html">dev.restate.sdk.common.function</a></div>
+<div class="col-last even-row-color">&nbsp;</div>
+<div class="col-first odd-row-color"><a href="dev/restate/sdk/common/syscalls/package-summary.html">dev.restate.sdk.common.syscalls</a></div>
+<div class="col-last odd-row-color">&nbsp;</div>
+<div class="col-first even-row-color"><a href="dev/restate/sdk/core/package-summary.html">dev.restate.sdk.core</a></div>
+<div class="col-last even-row-color">&nbsp;</div>
+<div class="col-first odd-row-color"><a href="dev/restate/sdk/core/manifest/package-summary.html">dev.restate.sdk.core.manifest</a></div>
+<div class="col-last odd-row-color">&nbsp;</div>
+<div class="col-first even-row-color"><a href="dev/restate/sdk/gen/package-summary.html">dev.restate.sdk.gen</a></div>
+<div class="col-last even-row-color">&nbsp;</div>
+<div class="col-first odd-row-color"><a href="dev/restate/sdk/gen/model/package-summary.html">dev.restate.sdk.gen.model</a></div>
+<div class="col-last odd-row-color">&nbsp;</div>
+<div class="col-first even-row-color"><a href="dev/restate/sdk/gen/template/package-summary.html">dev.restate.sdk.gen.template</a></div>
+<div class="col-last even-row-color">&nbsp;</div>
+<div class="col-first odd-row-color"><a href="dev/restate/sdk/gen/utils/package-summary.html">dev.restate.sdk.gen.utils</a></div>
+<div class="col-last odd-row-color">&nbsp;</div>
+<div class="col-first even-row-color"><a href="dev/restate/sdk/http/vertx/package-summary.html">dev.restate.sdk.http.vertx</a></div>
+<div class="col-last even-row-color">&nbsp;</div>
+<div class="col-first odd-row-color"><a href="dev/restate/sdk/lambda/package-summary.html">dev.restate.sdk.lambda</a></div>
+<div class="col-last odd-row-color">&nbsp;</div>
+<div class="col-first even-row-color"><a href="dev/restate/sdk/serde/jackson/package-summary.html">dev.restate.sdk.serde.jackson</a></div>
+<div class="col-last even-row-color">&nbsp;</div>
+<div class="col-first odd-row-color"><a href="dev/restate/sdk/serde/protobuf/package-summary.html">dev.restate.sdk.serde.protobuf</a></div>
+<div class="col-last odd-row-color">&nbsp;</div>
+<div class="col-first even-row-color"><a href="dev/restate/sdk/testing/package-summary.html">dev.restate.sdk.testing</a></div>
+<div class="col-last even-row-color">&nbsp;</div>
+<div class="col-first odd-row-color"><a href="dev/restate/sdk/version/package-summary.html">dev.restate.sdk.version</a></div>
+<div class="col-last odd-row-color">&nbsp;</div>
+</div>
+</main>
+</div>
+</div>
+</body>
+</html>