Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add javadocs test #352

Merged
merged 1 commit into from
Jun 10, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
20 changes: 20 additions & 0 deletions .github/workflows/ci.yml
Original file line number Diff line number Diff line change
Expand Up @@ -40,6 +40,26 @@ jobs:
name: Test results (Java ${{ matrix.java }})
path: "**/test-results/test/*.xml"

test-javadocs:
name: Test Javadocs
runs-on: ubuntu-latest
timeout-minutes: 10
steps:
- uses: actions/checkout@v4
- uses: actions/setup-java@v4
with:
# We test with same Java version and distribution used by the Docs script
# https://github.com/restatedev/documentation/blob/main/.github/workflows/pre-release.yml
distribution: 'temurin'
java-version: '21'
- name: Setup Gradle
uses: gradle/actions/setup-gradle@v3

- name: Build Javadocs
run: gradle :sdk-aggregated-javadocs:javadoc
- name: Build Kotlin docs
run: gradle :dokkaHtmlMultiModule

event_file:
name: "Event File"
runs-on: ubuntu-latest
Expand Down
6 changes: 2 additions & 4 deletions sdk-api/src/main/java/dev/restate/sdk/Context.java
Original file line number Diff line number Diff line change
Expand Up @@ -106,10 +106,8 @@ default void sleep(Duration duration) {
* <p>The closure should tolerate retries, that is Restate might re-execute the closure multiple
* times until it records a result.
*
* <h2>Error handling</h2>
*
* Errors occurring within this closure won't be propagated to the caller, unless they are {@link
* TerminalException}. Consider the following code:
* <p><b>Error handling</b>: Errors occurring within this closure won't be propagated to the
* caller, unless they are {@link TerminalException}. Consider the following code:
*
* <pre>{@code
* // Bad usage of try-catch outside the run
Expand Down
Loading