Skip to content

docs: Fix javadoc errors that broke publishing and gate PRs on the docs build #12

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.

Sign up for GitHub

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

Merged
Pijukatel merged 2 commits into from
Jul 24, 2026
Merged

docs: Fix javadoc errors that broke publishing and gate PRs on the docs build #12

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
7a972bb
Fix javadoc errors that broke the Maven Central publish workflow
claude Jul 24, 2026
265482d
Gate PRs on the release-profile javadoc build
claude Jul 24, 2026
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
7 changes: 7 additions & 0 deletions .github/workflows/java-integration-tests.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -50,6 +50,13 @@ jobs:
- name: Static analysis (SpotBugs)
run: mvn -B -DskipTests compile spotbugs:check

# Build the javadoc (and source) jars with the same release-profile configuration the publish
# workflow uses, so doclint errors — broken {@link} references, unknown tags, malformed
# HTML — fail the PR here instead of surfacing for the first time mid-release. Signing is
# skipped: only the docs build is under test, no GPG key is available or needed.
- name: Javadoc (release docs build)
run: mvn -B -Prelease -DskipTests -Dgpg.skip=true package

# Offline unit tests (mock HTTP backend): prove the retry/error/signature/pagination logic
# without the API. Selected by pattern — every hermetic test in the base package runs, and the
# token-gated integration/example/doc-snippet suites are excluded — so new hermetic tests are
Expand Down
21 changes: 21 additions & 0 deletions pom.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -216,6 +216,27 @@
<groupId>org.apache.maven.plugins</groupId>
<artifactId>maven-javadoc-plugin</artifactId>
<version>3.7.0</version>
<configuration>
<!-- Register the JDK-convention informational tags (JEP 8068562) so
javadoc does not reject them as unknown tags. -->
<tags>
<tag>
<name>apiNote</name>
<placement>a</placement>
<head>API Note:</head>
</tag>
<tag>
<name>implSpec</name>
<placement>a</placement>
<head>Implementation Requirements:</head>
</tag>
<tag>
<name>implNote</name>
<placement>a</placement>
<head>Implementation Note:</head>
</tag>
</tags>
</configuration>
<executions>
<execution>
<id>attach-javadocs</id>
Expand Down
2 changes: 1 addition & 1 deletion src/main/java/com/apify/client/actor/ActorListOptions.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@
import com.apify.client.internal.ListOptionsLike;
import com.apify.client.internal.QueryParams;

/** Options for {@link ActorCollectionClient#list(ActorListOptions)}. */
/** Options for {@link ActorCollectionClient#list ActorCollectionClient.list(ActorListOptions)}. */
public final class ActorListOptions implements ListOptionsLike {
private Long offset;
private Long limit;
Expand Down
Loading