Introduce a GitHub Actions workflow that automatically generates or updates JavaDoc comments for changed Java files in minerva-api using AI.
The workflow should run on pushes to the main branch and only target files that were modified in the commit.
The goal is to:
- Keep documentation up to date
- Reduce manual documentation effort
- Avoid undocumented code slipping into main
Workflow Behavior
Constraints
-
Only process files that actually changed
-
Do not overwrite existing meaningful JavaDoc blindly
-
Generated comments must:
- Be syntactically valid JavaDoc
- Match existing code behavior
-
Workflow must be idempotent
Requirements
- GitHub Actions workflow definition
- AI based JavaDoc generation step
- Safe handling of partial or repeated runs
- Clear logging of modified files
- Fail the workflow if JavaDoc generation fails
Acceptance Criteria
- JavaDoc is automatically added or updated for changed files
- No unrelated files are modified
- JavaDoc generation runs reliably on main
- Backend documentation stays consistently up to date
Introduce a GitHub Actions workflow that automatically generates or updates JavaDoc comments for changed Java files in
minerva-apiusing AI.The workflow should run on pushes to the
mainbranch and only target files that were modified in the commit.The goal is to:
Workflow Behavior
Trigger on push to
mainDetect changed
.javafiles insideminerva-apiFor each changed file:
Regenerate JavaDoc output after updates
Constraints
Only process files that actually changed
Do not overwrite existing meaningful JavaDoc blindly
Generated comments must:
Workflow must be idempotent
Requirements
Acceptance Criteria