Skip to content

docs: clarify plugin JAR selection and IDE module setup - #150

Merged
PimvanderLoos merged 1 commit into
gh_pagesfrom
docs/clarify-plugin-jar
Nov 6, 2026
Merged

PimvanderLoos merged 1 commit into
gh_pagesfrom
docs/clarify-plugin-jar

Conversation

@agentic-pim

@agentic-pim agentic-pim Bot commented Nov 6, 2026

Copy link
Copy Markdown
Contributor

Why

  • The setup example omitted the plugin JAR under test and left the two valid locations for userAgent unexplained.
  • The IDE command failed from multi-module project roots because it did not select the test module or explain execution IDs.

How

  • Update getting-started.html with the current module’s output JAR, packaging/shading guidance, and shared versus execution-level userAgent configuration.
  • Update ide-testing.html with module-directory, -pl :artifactId, and -f commands, execution-ID selection, and prefix-resolution troubleshooting.
  • Documentation only: existing runtime behavior and Java APIs are unchanged, so no code/Javadoc companion PR is needed.

Tests

  • PASS: mvn clean verify install -Perrorprone -Dmaven.javadoc.skip=true checkstyle:checkstyle pmd:check jacoco:report -Dgoal=helpmojo against master 08ad3f6 (Maven 3.9.9, Temurin 25.0.4, release 21), including 65 Paper and 65 Spigot integration tests.
  • PASS: python3 -m unittest discover -s .github/scripts -p 'test_*.py' -q (41 tests).
  • PASS: site_checks.py --source-only and example validation against the current API/plugin descriptor (3 Java examples compiled, 2 Maven examples validated).
  • PASS: Maven fixture reproduces root prefix failure; selecting the child by module path, :artifactId, or -f resolves its configured execution (preparation skipped).
  • PASS: node --check assets/main.js and git diff --check.

Complete the consumer setup guides by identifying the deployable plugin JAR and explaining shared userAgent configuration.

Make IDE preparation commands explicit about the owning module and execution ID, with multi-module examples and prefix-resolution troubleshooting. These changes address both reported setup gaps without changing runtime behavior.
@coderabbitai

coderabbitai Bot commented Nov 6, 2026

Copy link
Copy Markdown
Contributor

Important

Review skipped

Auto reviews are disabled on this repository. Please check the settings in the CodeRabbit UI or the .coderabbit.yaml file in this repository. To trigger a single review, invoke the @coderabbitai review command.

Run configuration

  • Source mode: Auto
  • Repository: Unavailable
  • Branch: Unavailable
  • File: No configuration file from this repository applied
  • Commit: Unavailable
  • Layers: Repository UI
  • Review profile: CHILL
  • Plan: Advanced
  • Run ID: 5f5f0f34-a667-468e-b9f8-92cb0bee52b5

You can disable this status message by setting the reviews.review_status to false in the CodeRabbit configuration file.

Use the checkbox below for a quick retry:

  • Trigger review
  • Autofix · Keep fixing CodeRabbit findings and required CI, and resolving merge conflicts

Tip

🎯 Customize your risk assessments

Guide how CodeRabbit assesses merge risk and security architecture risk. Highlight sensitive changes and explain your security boundaries using Merge Risk Instructions and Security Risk Instructions in your review settings. Security architecture risk assessments require the Advanced plan or above.

✅ Automatic approvals, with your rules

Let CodeRabbit approve pull requests once required threads are resolved, pre-merge checks pass, and your risk limits are met. Enable Automatic approvals in review settings, with overrides for teams or file paths.

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

@PimvanderLoos
PimvanderLoos merged commit a988dc4 into gh_pages Nov 6, 2026
2 checks passed
@PimvanderLoos
PimvanderLoos deleted the docs/clarify-plugin-jar branch November 6, 2026 15:11
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