Skip to content

Commit 1b83e11

Browse files
zeevmoneyclaude
andcommitted
Fix Javadoc errors and add CI validation
- Fix malformed HTML in GroupCreate.java and GroupRead.java by wrapping <resource_key:resource_instance_key> with {@code ...} - Add javadoc.yaml workflow to validate Javadoc on PRs and master pushes - Update publish.yaml to verify Javadoc before publishing Fixes PER-13670 🤖 Generated with [Claude Code](https://claude.com/claude-code) Co-Authored-By: Claude Opus 4.5 <noreply@anthropic.com>
1 parent 7d5ac47 commit 1b83e11

4 files changed

Lines changed: 53 additions & 8 deletions

File tree

.github/workflows/javadoc.yaml

Lines changed: 33 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,33 @@
1+
name: Javadoc Verification
2+
3+
on:
4+
pull_request:
5+
branches: [master]
6+
push:
7+
branches: [master]
8+
9+
jobs:
10+
javadoc:
11+
runs-on: ubuntu-latest
12+
steps:
13+
- uses: actions/checkout@v2
14+
- uses: actions/setup-java@v3.11.0
15+
with:
16+
java-version: '8'
17+
distribution: 'corretto'
18+
- name: Validate Gradle wrapper
19+
uses: gradle/wrapper-validation-action@v1
20+
- name: Generate Javadoc
21+
uses: gradle/gradle-build-action@v2
22+
with:
23+
arguments: javadoc
24+
- name: Check Javadoc generation
25+
run: |
26+
if [ -d "build/docs/javadoc" ]; then
27+
echo "Javadoc generated successfully"
28+
echo "Javadoc files:"
29+
find build/docs/javadoc -name "*.html" | head -20
30+
else
31+
echo "ERROR: Javadoc directory not found"
32+
exit 1
33+
fi

.github/workflows/publish.yaml

Lines changed: 18 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -1,15 +1,15 @@
11
name: Publish package to GitHub Packages
22
on:
33
release:
4-
types: [created]
4+
types: [ created ]
55
workflow_dispatch:
6-
6+
77
jobs:
88
publish:
9-
runs-on: ubuntu-latest
10-
permissions:
9+
runs-on: ubuntu-latest
10+
permissions:
1111
contents: read
12-
packages: write
12+
packages: write
1313
steps:
1414
- uses: actions/checkout@v2
1515
- uses: actions/setup-java@v3.11.0
@@ -18,6 +18,18 @@ jobs:
1818
distribution: 'corretto'
1919
- name: Validate Gradle wrapper
2020
uses: gradle/wrapper-validation-action@v1
21+
- name: Verify Javadoc generation
22+
uses: gradle/gradle-build-action@v2
23+
with:
24+
arguments: javadoc
25+
- name: Check Javadoc generation
26+
run: |
27+
if [ -d "build/docs/javadoc" ]; then
28+
echo "Javadoc verified successfully"
29+
else
30+
echo "ERROR: Javadoc directory not found"
31+
exit 1
32+
fi
2133
- name: Publish package
2234
uses: gradle/gradle-build-action@v2
2335
with:
@@ -29,4 +41,4 @@ jobs:
2941
GPG_SIGNING_KEY: ${{ secrets.GPG_SIGNING_KEY }}
3042
GPG_SIGNING_PASSPHRASE: ${{ secrets.GPG_SIGNING_PASSPHRASE }}
3143
NEXUS_TOKEN_USERNAME: ${{ secrets.NEXUS_TOKEN_USERNAME }}
32-
NEXUS_TOKEN_PASSWORD: ${{ secrets.NEXUS_TOKEN_PASSWORD }}
44+
NEXUS_TOKEN_PASSWORD: ${{ secrets.NEXUS_TOKEN_PASSWORD }}

src/main/java/io/permit/sdk/openapi/models/GroupCreate.java

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -39,7 +39,7 @@ public class GroupCreate {
3939
/**
4040
* Group Instance Key
4141
* <p>
42-
* Either the unique id of the resource instance that that the group belongs to, or the URL-friendly key of the <resource_key:resource_instance_key> (i.e: file:my_file)
42+
* Either the unique id of the resource instance that that the group belongs to, or the URL-friendly key of the {@code <resource_key:resource_instance_key>} (i.e: file:my_file)
4343
* (Required)
4444
*
4545
*/

src/main/java/io/permit/sdk/openapi/models/GroupRead.java

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -59,7 +59,7 @@ public class GroupRead {
5959
/**
6060
* GroupInstanceKey
6161
* <p>
62-
* Either the unique id of the resource instance that that the group belongs to, or the URL-friendly key of the <resource_key:resource_instance_key> (i.e: file:my_file)
62+
* Either the unique id of the resource instance that that the group belongs to, or the URL-friendly key of the {@code <resource_key:resource_instance_key>} (i.e: file:my_file)
6363
* (Required)
6464
*
6565
*/

0 commit comments

Comments
 (0)