Skip to content

Publish via com.vanniktech.maven.publish#536

Merged
mernst merged 1 commit intoplume-lib:masterfrom
mernst:developer-notes
Nov 10, 2025
Merged

Publish via com.vanniktech.maven.publish#536
mernst merged 1 commit intoplume-lib:masterfrom
mernst:developer-notes

Conversation

@mernst
Copy link
Copy Markdown
Contributor

@mernst mernst commented Nov 10, 2025

No description provided.

@coderabbitai
Copy link
Copy Markdown

coderabbitai bot commented Nov 10, 2025

📝 Walkthrough

Walkthrough

The pull request reorganizes the PMD ruleset by moving the AvoidBranchingStatementAsLastInLoop rule to a section for problematic rules with documentation of false positives. It introduces a new developer documentation file detailing the release process, including prerequisites, version updates, snapshot workflows, and client verification steps. The build configuration is updated to use the com.vanniktech.maven.publish plugin for Maven Central publishing in place of the legacy configuration, while introducing new Javadoc web publishing tasks for uploading and managing permissions. The legacy Maven Central publishing Gradle file is removed entirely.

Possibly related PRs

  • PMD linting #524: Modifies PMD ruleset configuration and build.gradle PMD-related settings in conjunction with this PR's changes to .pmd-ruleset.xml and build configuration.

Pre-merge checks and finishing touches

✅ Passed checks (1 passed)
Check name Status Explanation
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.
✨ Finishing touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Post copyable unit tests in a comment

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

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

Copy link
Copy Markdown

@coderabbitai coderabbitai bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Actionable comments posted: 7

📜 Review details

Configuration used: Path: .coderabbit.yaml

Review profile: ASSERTIVE

Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between 0b85275 and 6f07193.

📒 Files selected for processing (4)
  • .pmd-ruleset.xml (1 hunks)
  • README-developers.md (1 hunks)
  • build.gradle (5 hunks)
  • gradle/mavencentral.gradle (0 hunks)
💤 Files with no reviewable changes (1)
  • gradle/mavencentral.gradle
🔇 Additional comments (5)
.pmd-ruleset.xml (1)

296-297: Appropriate documentation of known false positives.

Moving AvoidBranchingStatementAsLastInLoop to the broken rules section with clear documentation of the false positive case (triggering on return statements) improves maintainability and clarity for future contributors.

build.gradle (2)

119-122: Good inline documentation of Error Prone disable rationale.

The added comments (lines 119-122) explaining why specific Error Prone checks are disabled improve maintainability. These clarifications help future developers understand the reasoning behind each disable.


25-25: Maven publishing configuration looks good overall.

The mavenPublishing block is well-structured with complete POM metadata (name, description, URL, SCM, licenses, developers). Adding mavenLocal() to repositories enables local snapshot testing as documented. The plugin version (0.34.0) appears current.

After addressing the version hardcoding issue above, verify the signing and Maven Central credentials are properly configured in ~/.gradle/gradle.properties as documented in README-developers.md lines 7-14.

Also applies to: 280-309

README-developers.md (2)

19-19: Documentation accurately reflects environment requirements.

The note "Run these steps on any filesystem, except the javadocWeb step" (line 19) is clear and correctly positions the CSE-filesystem requirement. This aligns well with the hardcoded path in build.gradle and appropriately sets expectations for contributors.


49-77: Snapshot release workflow is well-documented with both approaches.

The dual approach for snapshot releases (Maven Central vs Maven Local) with corresponding client configuration is thorough and gives developers flexibility for testing.

Comment thread build.gradle
Comment thread build.gradle
Comment thread build.gradle
Comment thread build.gradle
Comment thread README-developers.md
Comment thread README-developers.md
Comment thread README-developers.md
@mernst mernst merged commit bf23c9d into plume-lib:master Nov 10, 2025
4 checks passed
@mernst mernst deleted the developer-notes branch November 10, 2025 18:19
@coderabbitai coderabbitai bot mentioned this pull request Nov 11, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant