Skip to content

Commit

Permalink
Add GitHub Actions job for JavaDoc verification
Browse files Browse the repository at this point in the history
  • Loading branch information
pivovarit committed Oct 17, 2024
1 parent b8475f4 commit 0a51a72
Show file tree
Hide file tree
Showing 2 changed files with 23 additions and 3 deletions.
16 changes: 16 additions & 0 deletions .github/workflows/build.yml
Original file line number Diff line number Diff line change
Expand Up @@ -31,3 +31,19 @@ jobs:
- name: Build with Maven
run: mvn package

verify-javadoc:
runs-on: ubuntu-latest
name: Validate JavaDocs
steps:
- uses: actions/checkout@v4
- name: Setup JDK
uses: actions/setup-java@v4
with:
distribution: 'temurin'
java-version: '23'
architecture: 'x64'
cache: 'maven'

- name: Validate JavaDocs
run: mvn package -DskipTests=true javadoc:javadoc

10 changes: 7 additions & 3 deletions pom.xml
Original file line number Diff line number Diff line change
@@ -1,5 +1,6 @@
<?xml version="1.0" encoding="UTF-8"?>
<project xmlns="http://maven.apache.org/POM/4.0.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd">
<project xmlns="http://maven.apache.org/POM/4.0.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd">

<licenses>
<license>
Expand All @@ -25,8 +26,8 @@
<url>https://github.com/pivovarit/parallel-collectors</url>
<connection>scm:git:[email protected]:pivovarit/parallel-collectors.git</connection>
<developerConnection>scm:git:[email protected]:pivovarit/parallel-collectors.git</developerConnection>
<tag>HEAD</tag>
</scm>
<tag>HEAD</tag>
</scm>

<properties>
<project.build.sourceEncoding>UTF-8</project.build.sourceEncoding>
Expand Down Expand Up @@ -135,6 +136,9 @@
</goals>
</execution>
</executions>
<configuration>
<failOnWarnings>true</failOnWarnings>
</configuration>
</plugin>
<plugin>
<groupId>org.apache.maven.plugins</groupId>
Expand Down

0 comments on commit 0a51a72

Please sign in to comment.