open-telemetry / open-telemetry/opentelemetry-java-contrib

Publish modules with appropriate stability suffix.

Open
#2,078 10 comments 1 reaction 0 assignees View on GitHub

Nobody has claimed this yet.

enhancement help wanted
Dominant language
Java
Stars
269
Forks
196
Avg merge
2d 7h
Merged PRs (30d)
38

Description

The topmost README.md contains a list of all of the modules in this repo under "Provided Libraries". This table contains each library name (linked to the module) and a "status" column, which is a stability field (one of alpha, beta, or stable).

However, because we publish all modules at the same time with the same version number, they all result in an -alpha suffix. This is confusing because beta modules have an alpha suffix (example), as does the stable one (example).

However, modules that don't yet have a otel.stable=true in their gradle.properties file will publish with the -alpha suffix even when they are marked as beta (example). It seems that the stable artifacts do actually have the -alpha suffix omitted.

It would be awesome if we could find a way to declare the stability of each module and publish its artifacts with the appropriate suffix (or none for stable).

(Also related to #2077)

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

Start with the top-level README.md module table and compare each module's status with its gradle.properties, especially the otel.stable=true setting. Trace the existing publication configuration to see how the version suffix is selected. Done means alpha, beta, and stable modules publish with matching suffixes, with stable artifacts omitting the suffix.

Written by the indexing model from the issue text.

Assessment

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

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.