cloudevents / cloudevents/sdk-java

Support full Java Module descriptors

Open
#555 7 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Dominant language
Java
Stars
446
Forks
172
PR merge metrics
No merged PRs in 30d

Description

v2.4.2 defines automatic module names for all Maven modules

$ jarviz module name --gav io.cloudevents:cloudevents-core:2.4.2
subject: cloudevents-core-2.4.2.jar
name: io.cloudevents.core
source: manifest
automatic: true
valid: true

$ jarviz module descriptor --gav io.cloudevents:cloudevents-core:2.4.2
subject: cloudevents-core-2.4.2.jar
name: io.cloudevents.core
version: 2.4.2
open: false
automatic: true
requires:
  java.base mandated
contains:
  io.cloudevents.core
  io.cloudevents.core.builder
  io.cloudevents.core.data
  io.cloudevents.core.extensions
  io.cloudevents.core.extensions.impl
  io.cloudevents.core.format
  io.cloudevents.core.impl
  io.cloudevents.core.message
  io.cloudevents.core.message.impl
  io.cloudevents.core.provider
  io.cloudevents.core.v03
  io.cloudevents.core.v1

I'd be great if the library supplied full Java module descriptors. It's possible to keep bytecode baseline compatible with Java 8 while providing a full module descriptor thanks to ModiTect. This will help modular projects that consume artifacts from this specification, specifically those that create custom Java Runtimes with jlink, as the latter does not support automatic modules but explicit modules.

I've checked all artifacts provided in cloudevents-bom-2.4.2 and there are no split packages.

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

No source files or tests are named. Start by reviewing the Maven modules and the artifacts listed in cloudevents-bom-2.4.2, then examine how ModiTect could provide explicit module descriptors while preserving the Java 8 bytecode baseline. Done means the artifacts expose full descriptors, avoid split packages, and support jlink-based modular runtimes.

Written by the indexing model from the issue text.

Assessment

Tech stack
java
Domain
build-system
Issue type
Feature
Difficulty
4/5
Estimated time
3-5 days
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
35/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.