Skip to content

AGENTS.md

Latest commit

 

History

History
59 lines (47 loc) · 2.5 KB

AGENTS.md

File metadata and controls

59 lines (47 loc) · 2.5 KB
Raw

Connect Java Agent Instructions

Connect Java builds the platform plugins used by Connect endpoints. Treat plugin release, hub image rebuild, and production rollout as separate steps.

Worktree Safety

  • The root worktree may contain active libp2p or transport feature branches. Do not modify an active worktree unless explicitly asked.
  • For unrelated fixes or release docs, create a separate worktree from origin/connect.
  • Preserve user changes. Never reset or force-clean active branches.

Release Flow

  • Stable plugin artifacts are published from GitHub releases managed by release-please.yml on the connect branch.
  • Use Conventional Commit prefixes to drive releases: fix: for patch, feat: for minor, and feat!:/BREAKING CHANGE: for major. Non-release prefixes such as chore:, docs:, ci:, and test: should not cut a stable release.
  • release-please.yml opens and auto-merges a release PR, creates the version tag/release, then dispatches release.yml on that tag so the JAR artifacts are uploaded. Do not manually bump versions or create release tags unless repairing automation.
  • The release.yml workflow uploads: connect-spigot.jar, connect-velocity.jar, connect-bungee.jar, and LICENSE.
  • Pushes to connect still update the latest-prerelease release for unreleased testing builds.
  • After creating a release, verify the release is not draft/prerelease unless intentionally so, and verify the asset digest/availability:
gh -R minekube/connect-java release view <version> --json tagName,targetCommitish,isDraft,isPrerelease,assets
curl -I -L --fail https://github.com/minekube/connect-java/releases/download/<version>/connect-velocity.jar

Velocity Join Bugs

  • For Velocity proxy issues, test both CONFIGURATION and PLAY state packet handling. Reconfiguration packets can arrive before normal play state.
  • Keep Connect's Netty/runtime isolation intact. Avoid reusing server pipeline state across the connector runtime without a focused test.
  • If a hub uses this plugin, update the hub's velocity/deps.env, rebuild the hub image, deploy through gitops, and verify a real public join.

Verification

Run targeted module tests for packet/session fixes, then the broader build:

./gradlew :velocity:test
./gradlew build

Do not call production fixed from a Connect Java release alone. Confirm the released jar is in the hub image, the hub pod logs the expected plugin version, and Moxy accepts a tunnel with the same connectorVersion.