Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Make status of this repo clearer #20

Merged
merged 1 commit into from
Nov 11, 2024
Merged

Make status of this repo clearer #20

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
21 changes: 21 additions & 0 deletions CONTRIBUTING.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,21 @@
## Project setup

The build downloads proto definitions
from [open-telemetry/opentelemetry-proto](https://github.com/open-telemetry/opentelemetry-proto) and
generates Java bindings:

```shell
./gradlew build
```

By default protos definitions will be downloaded for the latest published tag
of `opentelemetry-proto-java`. For example, if the latest version
is [0.20.0](https://github.com/open-telemetry/opentelemetry-proto-java/tree/v0.20.0), protos will be
downloaded from
the [v0.20.0 release](https://github.com/open-telemetry/opentelemetry-proto/releases/tag/v0.20.0).
This can be overridden for the build or other gradle tasks (e.g. `publishToMavenLocal`)
with `-Prelease.version.prop`:

```shell
./gradlew build -Prelease.version.prop=1.0.0
```
69 changes: 4 additions & 65 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,72 +1,11 @@
# <img src="https://opentelemetry.io/img/logos/opentelemetry-logo-nav.png" alt="OpenTelemetry Icon" width="45" height=""> Java Bindings for the OpenTelemetry Protocol (OTLP)

[![Maven Central](https://img.shields.io/maven-central/v/io.opentelemetry.proto/opentelemetry-proto.svg?label=Maven%20Central)](https://search.maven.org/search?q=g:%22io.opentelemetry.proto%22%20AND%20a:%22opentelemetry-proto%22)

Java code-generation for the OpenTelemetry Protocol Buffer data model. This repository contains
workflows and build scripts that pull releases
from [opentelemetry-proto](https://github.com/open-telemetry/opentelemetry-proto) to generate and
build Java bindings and publish them to the
[Maven Central Repository](https://search.maven.org/artifact/io.opentelemetry.proto/opentelemetry-proto).

## Published releases

You can use the published releases available
on [Maven Central](https://search.maven.org/artifact/io.opentelemetry.proto/opentelemetry-proto). To
do so, add the following as dependencies to your build configuration and replace `{{version}}` with
your desired version.

### Maven

```xml

<dependency>
<groupId>io.opentelemetry.proto</groupId>
<artifactId>opentelemetry-proto</artifactId>
<version>{{version}}</version>
</dependency>
```

### Gradle

```kotlin
implementation("io.opentelemetry.proto:opentelemetry-proto:{{version}}")
```

## Project setup

The build downloads proto definitions
from [open-telemetry/opentelemetry-proto](https://github.com/open-telemetry/opentelemetry-proto) and
generates Java bindings:

```shell
./gradlew build
```

By default protos definitions will be downloaded for the latest published tag
of `opentelemetry-proto-java`. For example, if the latest version
is [0.20.0](https://github.com/open-telemetry/opentelemetry-proto-java/tree/v0.20.0), protos will be
downloaded from
the [v0.20.0 release](https://github.com/open-telemetry/opentelemetry-proto/releases/tag/v0.20.0).
This can be overridden for the build or other gradle tasks (e.g. `publishToMavenLocal`)
with `-Prelease.version.prop`:

```shell
./gradlew build -Prelease.version.prop=1.0.0
```

## Support
# :warning: Not intended for production use :warning:

The generated java bindings published from this repository are provided as-is.

For generic documentation on how to use protobuf bindings,
see [gRPC documentation](https://grpc.io/docs/languages/java/generated-code/)
and [protobuf java documentation](https://protobuf.dev/reference/java/java-generated/).
They are only used within the OpenTelemetry project by test suites
and are not intended for production use.

We have no intention of eventually publishing stable artifacts. If you need guarantees,
There is no intention of eventually publishing stable artifacts. If you need any guarantees,
please generate your own bindings,
consulting [grpc codegen](https://grpc.io/docs/languages/java/generated-code/#codegen) and
possibly [build.gradle.kts](build.gradle.kts)

## Releasing

See [RELEASING.md](./RELEASING.md)
Loading