Skip to content

Commit 73f0660

Browse files
committed
feat: publis java docs
1 parent e25e771 commit 73f0660

2 files changed

Lines changed: 59 additions & 0 deletions

File tree

Lines changed: 39 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,39 @@
1+
# Copyright 2025 Google LLC
2+
#
3+
# Licensed under the Apache License, Version 2.0 (the "License");
4+
# you may not use this file except in compliance with the License.
5+
# You may obtain a copy of the License at
6+
#
7+
# http://www.apache.org/licenses/LICENSE-2.0
8+
#
9+
# Unless required by applicable law or agreed to in writing, software
10+
# distributed under the License is distributed on an "AS IS" BASIS,
11+
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
12+
# See the License for the specific language governing permissions and
13+
# limitations under the License.
14+
#
15+
# SPDX-License-Identifier: Apache-2.0
16+
17+
name: Publish Javadoc
18+
19+
on:
20+
push:
21+
branches:
22+
- main
23+
24+
jobs:
25+
publish:
26+
runs-on: ubuntu-latest
27+
permissions:
28+
contents: write
29+
30+
steps:
31+
- name: Deploy JavaDoc 🚀
32+
uses: MathieuSoysal/Javadoc-publisher.yml@v3.0.2
33+
with:
34+
GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
35+
javadoc-branch: gh-pages
36+
java-version: 21
37+
target-folder: javadoc
38+
project: maven
39+
custom-command: mvn javadoc:aggregate

pom.xml

Lines changed: 20 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -310,6 +310,15 @@
310310
<failOnError>false</failOnError>
311311
<failOnWarnings>false</failOnWarnings>
312312
<quiet>true</quiet>
313+
<show>public</show>
314+
<nohelp>true</nohelp>
315+
<outputDirectory>${project.build.directory}/javadoc</outputDirectory>
316+
<reportOutputDirectory>${project.build.directory}/javadoc</reportOutputDirectory>
317+
<destDir>javadoc</destDir>
318+
<doctitle>Genkit for Java ${project.version} API</doctitle>
319+
<windowtitle>Genkit for Java API</windowtitle>
320+
<source>${java.version}</source>
321+
<encoding>UTF-8</encoding>
313322
</configuration>
314323
<executions>
315324
<execution>
@@ -318,6 +327,17 @@
318327
<goal>jar</goal>
319328
</goals>
320329
</execution>
330+
<execution>
331+
<id>aggregate</id>
332+
<goals>
333+
<goal>aggregate</goal>
334+
</goals>
335+
<phase>site</phase>
336+
<configuration>
337+
<outputDirectory>${project.basedir}/target/javadoc</outputDirectory>
338+
<reportOutputDirectory>${project.basedir}/target/javadoc</reportOutputDirectory>
339+
</configuration>
340+
</execution>
321341
</executions>
322342
</plugin>
323343
<!-- Spotless for code formatting (Eclipse JDT) -->

0 commit comments

Comments
 (0)