ci(automation): enhance repository automation and code quality workflows (#320) by KHARSHAVARDHAN-eng · Pull Request #360 · apache/hugegraph-computer

KHARSHAVARDHAN-eng · 2026-08-10T03:09:03Z

Description

This PR addresses the recommendations from the Automation Analysis report (#320) by introducing automatic code formatting, test coverage enforcement, PR commit validation, release notes generation, and developer automation documentation.

Key Changes

Automatic Code Formatting (computer/pom.xml):
- Added spotless-maven-plugin (v2.30.0) for automated Java code formatting (mvn spotless:apply and mvn spotless:check).
Test Coverage Tracking (computer/pom.xml):
- Added jacoco-maven-plugin (v0.8.8) with prepare-agent and report goals to automatically generate test coverage reports during mvn test.
Commit & PR Title Validation (.github/workflows/commit-check.yml):
- Added a GitHub Action workflow to validate PR titles against the Conventional Commits specification.
Automated Release Notes (.github/workflows/release-notes.yml):
- Added a GitHub Action workflow to generate release drafts and changelogs automatically when tags (v*) are pushed.
Documentation (docs/automation-guide.md):
- Created comprehensive documentation detailing formatting commands, test coverage generation, RAT license checks, and PR contribution guidelines.

Reference

Fixes #320

…pache#355) - Create computer-rust crate with high-performance CSR graph representation, PageRank, SSSP, and atomic aggregator kernels - Implement C-ABI export layer (computer_rust_c_api.h) for FFI interoperability - Add dataset fixtures (Karate Club, synthetic power-law) and differential tolerance check suite - Add Java RustKernelBridge in computer-core with graceful fallback logic and unit tests - Add Go RustKernelBridge in vermeer with fallback execution and unit tests - Create .github/workflows/rust-ci.yml for Rust linting, testing, and formatting - Add docs/rust-modernization-roadmap.md detailing architecture, guardrails, baselines, and newcomer-friendly child tasks

…ows (apache#320) - Add spotless-maven-plugin to computer/pom.xml for automated Java code formatting (mvn spotless:apply / spotless:check) - Add jacoco-maven-plugin to computer/pom.xml for automated test coverage report generation - Create .github/workflows/commit-check.yml to validate PR titles against Conventional Commits formatting rules - Create .github/workflows/release-notes.yml for automated GitHub release draft generation - Create docs/automation-guide.md documenting repository code quality tools and PR guidelines

imbajin

Blocking: yes. Summary: The exact head introduces correctness and native-integration blockers in the new Rust kernels, Java/Go bridges, and CI workflows. Evidence: static review of the exact base/head diff, plus exact-head workflow runs showing Rust CI startup_failure and other required checks in action_required.

imbajin · 2026-08-12T17:39:33Z

+    pub fn from_edges(num_vertices: u32, edges: &[(u32, u32, f64)]) -> Self {
+        let mut degree = vec![0; num_vertices as usize];
+        for &(src, _dst, _weight) in edges {
+            if src < num_vertices {


⚠️ important — The degree pass counts every edge with a valid source, while the fill pass skips destinations outside num_vertices. For an edge such as (1, 99, 1.0), row_offsets reserves a slot that remains the default (target=0, weight=0), so PageRank and SSSP process a fabricated edge. Count only edges with both endpoints valid, or reject invalid endpoints at the API boundary.

imbajin · 2026-08-12T17:39:33Z

+        return -1;
+    }
+    let builder = unsafe { &mut *handle };
+    builder.edges.push((src, dst, weight));


⚠️ important — computer_graph_add_edge accepts arbitrary f64 weights, but SsspKernel uses Dijkstra. Negative weights can return incorrect shortest paths and a reachable negative cycle can keep lowering distances and growing the heap; non-finite weights are also unbounded input. Reject non-finite and negative weights here, or change the algorithm and document the supported weight domain.

imbajin · 2026-08-12T17:39:33Z

+use crate::RUST_KERNEL_VERSION;
+use std::ffi::CString;
+use std::os::raw::c_char;
+use std::ptr;


⚠️ important — std::ptr is unused. The added Rust workflow runs cargo clippy --all-targets -- -D warnings, so this import is promoted to an error and prevents the Rust CI job from reaching its tests. Remove the import or use it deliberately.

imbajin · 2026-08-12T17:39:33Z

+        return ranks;
+    }
+
+    private static native String nativeGetVersion();


⚠️ important — This Java native declaration does not match the library's exported ABI: Rust exports the C function computer_kernel_version, but no JNI symbol for nativeGetVersion, and computePageRank never calls a native function. If the library loads, isAvailable() becomes true while version lookup falls back after UnsatisfiedLinkError and computation still runs in Java. Add JNI/C-ABI bindings for the required calls and make availability reflect callable symbols.

imbajin · 2026-08-12T17:39:33Z

+
+func NewRustKernelBridge() *RustKernelBridge {
+	return &RustKernelBridge{
+		available: false,


⚠️ important — available is hard-coded to false, and this package contains no cgo declaration, library loading, or Rust C-ABI call. Vermeer therefore always executes the Go fallback even when the Rust library is deployed, making the new native bridge unreachable. Implement initialization and native calls, or remove the native-bridge claim and keep this as an explicitly fallback-only implementation.

imbajin · 2026-08-12T17:39:33Z

+  push:
+    branches:
+      - master
+      - /^release-.*$/


⚠️ important — GitHub Actions branch filters use glob patterns, not regular expressions. ^/release-.*$/ therefore does not match normal release-* branches, so Rust CI is skipped for release-branch pushes. Replace it with a supported glob such as release-* and verify the trigger.

imbajin · 2026-08-12T17:39:34Z

+on:
+  push:
+    tags:
+      - 'v*'


⚠️ important — This workflow triggers only for v* tags, while the repository's existing release tags use the 1.0.0/1.5.0/1.7.0 form. A normal version tag will not run this workflow and will not produce draft release notes. Align the trigger with the repository's release convention or update the release process consistently.

bitflicker64

Blocking: no. Summary: The automation change is sound in intent, but the new parent-level JaCoCo block duplicates the JaCoCo already configured in computer/computer-test/pom.xml, and the child's explicit 0.8.4 overrides the declared 0.8.8 in exactly the module that feeds the Codecov upload — leaving a 0.8.8 agent paired with a 0.8.4 aggregator; Spotless duplicates a Checkstyle rule that is already enforced and is not wired into any build; and both new workflows omit a permissions: block, which the release job actually needs (contents: write). Evidence: mvn -o help:effective-pom at head e533ae8 shows jacoco 0.8.4 with four merged executions for computer-test versus 0.8.8 for computer-core; checkstyle.xml:47,49 already declares RedundantImport/UnusedImports with maven-checkstyle-plugin bound to validate; mvn -B spotless:check passes across all 10 modules today; stale.yml, codeql-analysis.yml and rerun-ci.yml all declare explicit least-privilege permissions:. Note: the release-notes.yml v* tag mismatch was independently reproduced (all 8 repo tags are unprefixed, e.g. 1.7.0) but is omitted here as already reported on this head. This review covers only the 4 files in commit e533ae8; the +1508 lines of Rust/JNI/Go come from the stacked, unmerged #359. gh pr checks 360 reports no checks on this branch, so the added workflows are unexercised.

bitflicker64 · 2026-09-01T05:34:15Z

+                    </java>
+                </configuration>
+            </plugin>
+            <plugin>


⚠️ important — This duplicates JaCoCo, which is already configured in computer/computer-test/pom.xml:176-198 (v0.8.4, pre-test/prepare-agent + post-test/report-aggregate writing to ${basedir}/../target/site/jacoco, the exact path computer-ci.yml:110-115 uploads to Codecov). A parent-level <build><plugins> entry is inherited by every module and merges with the child declaration instead of replacing it.

mvn -o help:effective-pom at this head:

-pl computer-test → version resolves to 0.8.4 (the child's explicit version wins, so the declared 0.8.8 never takes effect here) with four executions: the new prepare-agent and report plus the existing pre-test and post-test.

-pl computer-core → version 0.8.8.

So sibling modules instrument with the 0.8.8 agent while computer-test's 0.8.4 report-aggregate analyzes those jacoco.exec files, and computer-test runs a redundant report alongside report-aggregate in the same test phase. (The duplicated prepare-agent itself is harmless — the second execution overwrites argLine with an identical value rather than adding a second -javaagent.)

Please drop this block, or consolidate to a single declaration: remove the computer-test one, settle on one version, and keep the report-aggregate output path that Codecov consumes.

bitflicker64 · 2026-09-01T05:34:15Z

+jobs:
+  generate-release-notes:
+    name: Generate Release Draft & Notes
+    runs-on: ubuntu-latest


⚠️ important — This job declares no permissions: block, but softprops/action-gh-release documents permissions: contents: write as required to create a release. With no block the token falls back to the repository/org default; where that default is read-only the step fails with HTTP 403 at tag time, i.e. exactly when a release is being cut. This is separate from the tag-pattern issue already raised below: correcting the trigger alone still leaves the job unable to create the draft.

It also diverges from this repo's convention of explicit least privilege — stale.yml:11-13 (issues: write, pull-requests: write), codeql-analysis.yml:23-26 (actions: read, contents: read, security-events: write), rerun-ci.yml:10 (permissions: {}).

Please add to this job:

permissions: contents: write

(I could not read the repository's effective default workflow permission — the API returns 403 for my token — but declaring it explicitly is correct either way.)

bitflicker64 · 2026-09-01T05:34:15Z

                    </execution>
                </executions>
            </plugin>
+            <plugin>


🧹 minor — The only step configured here is <removeUnusedImports/>, which duplicates a rule the build already enforces: checkstyle.xml:47,49 declares RedundantImport and UnusedImports, and maven-checkstyle-plugin binds check to the validate phase with failsOnError=true (computer/pom.xml:373-394).

There is also no <executions> binding and computer-ci.yml was not updated to call spotless:check, so nothing runs automatically despite the PR describing "Automatic Code Formatting" — only a manual mvn spotless:apply. For what it's worth the plugin does work and the tree is already clean: mvn -B spotless:check passes across all 10 modules at this head.

Either configure steps Checkstyle does not already cover (import order, license header, a formatter) and wire spotless:check into a phase and CI, or drop the plugin along with its docs/automation-guide.md section — as configured it adds a build dependency for no net capability.

bitflicker64 · 2026-09-01T05:34:15Z

+jobs:
+  validate-pr-title:
+    name: Validate PR Title & Format
+    runs-on: ubuntu-latest


🧹 minor — This job also declares no permissions: block, so it inherits the default token scope. It only needs to read the PR title, and the rest of this repo pins least privilege explicitly (stale.yml:11-13, codeql-analysis.yml:23-26, rerun-ci.yml:10).

Please add:

permissions: pull-requests: read

KHARSHAVARDHAN-eng added 2 commits August 10, 2026 08:34

dosubot Bot added size:XXL This PR changes 1000+ lines, ignoring generated files. documentation Improvements or additions to documentation labels Aug 10, 2026

imbajin reviewed Aug 12, 2026

View reviewed changes

bitflicker64 reviewed Sep 1, 2026

View reviewed changes

Navigation Menu

Uh oh!

ci(automation): enhance repository automation and code quality workflows (#320) - #360

ci(automation): enhance repository automation and code quality workflows (#320)#360
KHARSHAVARDHAN-eng wants to merge 2 commits into
apache:masterfrom
KHARSHAVARDHAN-eng:feature/automation-analysis-320

KHARSHAVARDHAN-eng commented Aug 10, 2026

Uh oh!

imbajin left a comment

Uh oh!

imbajin Aug 12, 2026

Uh oh!

imbajin Aug 12, 2026

Uh oh!

imbajin Aug 12, 2026

Uh oh!

imbajin Aug 12, 2026

Uh oh!

imbajin Aug 12, 2026

Uh oh!

imbajin Aug 12, 2026

Uh oh!

imbajin Aug 12, 2026

Uh oh!

bitflicker64 left a comment

Uh oh!

bitflicker64 Sep 1, 2026

Uh oh!

bitflicker64 Sep 1, 2026

Uh oh!

bitflicker64 Sep 1, 2026

Uh oh!

bitflicker64 Sep 1, 2026

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants

Uh oh!

Conversation

KHARSHAVARDHAN-eng commented Aug 10, 2026

Description

Key Changes

Reference

Uh oh!

imbajin left a comment

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

bitflicker64 left a comment

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants