Add Javadoc generation and dependency review to CI

[yamcodes]

Summary by CodeRabbit

• Chores
  • Enhanced CI/CD pipeline with comprehensive build verification combining compilation and testing in a single step.
  • Added automated Javadoc documentation generation to the workflow.
  • Introduced dependency security review checks for pull requests to identify potential vulnerabilities.

[coderabbitai]

Walkthrough

The CI workflow configuration is updated to replace the Maven test step with a verify step that builds and tests together, adds Javadoc generation, and introduces a dependency review check for pull requests.

Changes

Cohort / File(s)	Summary
CI Workflow Updates .github/workflows/ci.yml	Replaces mvn -B test with mvn -B verify for combined build and test. Adds Javadoc generation step with mvn -B javadoc:javadoc. Adds dependency review action for pull request events.

Estimated code review effort

🎯 1 (Trivial) | ⏱️ ~3 minutes

Poem

🐰 With verify steps and docs so fine,
Dependencies reviewed in line,
The CI pipeline hops with glee,
Building, testing, all we see!
A workflow blessed, complete, and true.

🚥 Pre-merge checks | ✅ 3

✅ Passed checks (3 passed)

Check name	Status	Explanation
Description Check	✅ Passed	Check skipped - CodeRabbit’s high-level summary is enabled.
Title check	✅ Passed	The title accurately reflects the main changes: adding Javadoc generation and dependency review to the CI workflow.
Docstring Coverage	✅ Passed	No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.

_{✏️ Tip: You can configure your own custom pre-merge checks in the settings.}

✨ Finishing touches

🧪 Generate unit tests (beta)

• Create PR with unit tests
• Post copyable unit tests in a comment
• Commit unit tests in branch ci-test-improvements

---

No actionable comments were generated in the recent review. 🎉

🧹 Recent nitpick comments

.github/workflows/ci.yml (1)

23-27: Consider combining Javadoc generation into the verify step.

Running a separate mvn invocation re-resolves dependencies and re-reads the POM. You can bind both into a single call:

     - name: Build and test
-      run: mvn -B verify
-
-    - name: Generate Javadoc
-      run: mvn -B javadoc:javadoc
+      run: mvn -B verify javadoc:javadoc

That said, keeping them separate gives clearer step-level feedback in the Actions UI, so this is purely a trade-off of speed vs. readability.

---

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

• X
• Mastodon
• Reddit
• LinkedIn

_{Comment @coderabbitai help to get the list of available commands and usage tips.}

[yamcodes]

@all-contributors please add @yamcodes for infra

[allcontributors]

@yamcodes

I've put up a pull request to add @yamcodes! 🎉