Skip to content

Commit 7f3d19c

Browse files
authored
Make status of this repo clearer (#20)
1 parent 835072e commit 7f3d19c

File tree

2 files changed

+25
-65
lines changed

2 files changed

+25
-65
lines changed

CONTRIBUTING.md

Lines changed: 21 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,21 @@
1+
## Project setup
2+
3+
The build downloads proto definitions
4+
from [open-telemetry/opentelemetry-proto](https://github.com/open-telemetry/opentelemetry-proto) and
5+
generates Java bindings:
6+
7+
```shell
8+
./gradlew build
9+
```
10+
11+
By default protos definitions will be downloaded for the latest published tag
12+
of `opentelemetry-proto-java`. For example, if the latest version
13+
is [0.20.0](https://github.com/open-telemetry/opentelemetry-proto-java/tree/v0.20.0), protos will be
14+
downloaded from
15+
the [v0.20.0 release](https://github.com/open-telemetry/opentelemetry-proto/releases/tag/v0.20.0).
16+
This can be overridden for the build or other gradle tasks (e.g. `publishToMavenLocal`)
17+
with `-Prelease.version.prop`:
18+
19+
```shell
20+
./gradlew build -Prelease.version.prop=1.0.0
21+
```

README.md

Lines changed: 4 additions & 65 deletions
Original file line numberDiff line numberDiff line change
@@ -1,72 +1,11 @@
1-
# <img src="https://opentelemetry.io/img/logos/opentelemetry-logo-nav.png" alt="OpenTelemetry Icon" width="45" height=""> Java Bindings for the OpenTelemetry Protocol (OTLP)
2-
3-
[![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)
4-
5-
Java code-generation for the OpenTelemetry Protocol Buffer data model. This repository contains
6-
workflows and build scripts that pull releases
7-
from [opentelemetry-proto](https://github.com/open-telemetry/opentelemetry-proto) to generate and
8-
build Java bindings and publish them to the
9-
[Maven Central Repository](https://search.maven.org/artifact/io.opentelemetry.proto/opentelemetry-proto).
10-
11-
## Published releases
12-
13-
You can use the published releases available
14-
on [Maven Central](https://search.maven.org/artifact/io.opentelemetry.proto/opentelemetry-proto). To
15-
do so, add the following as dependencies to your build configuration and replace `{{version}}` with
16-
your desired version.
17-
18-
### Maven
19-
20-
```xml
21-
22-
<dependency>
23-
<groupId>io.opentelemetry.proto</groupId>
24-
<artifactId>opentelemetry-proto</artifactId>
25-
<version>{{version}}</version>
26-
</dependency>
27-
```
28-
29-
### Gradle
30-
31-
```kotlin
32-
implementation("io.opentelemetry.proto:opentelemetry-proto:{{version}}")
33-
```
34-
35-
## Project setup
36-
37-
The build downloads proto definitions
38-
from [open-telemetry/opentelemetry-proto](https://github.com/open-telemetry/opentelemetry-proto) and
39-
generates Java bindings:
40-
41-
```shell
42-
./gradlew build
43-
```
44-
45-
By default protos definitions will be downloaded for the latest published tag
46-
of `opentelemetry-proto-java`. For example, if the latest version
47-
is [0.20.0](https://github.com/open-telemetry/opentelemetry-proto-java/tree/v0.20.0), protos will be
48-
downloaded from
49-
the [v0.20.0 release](https://github.com/open-telemetry/opentelemetry-proto/releases/tag/v0.20.0).
50-
This can be overridden for the build or other gradle tasks (e.g. `publishToMavenLocal`)
51-
with `-Prelease.version.prop`:
52-
53-
```shell
54-
./gradlew build -Prelease.version.prop=1.0.0
55-
```
56-
57-
## Support
1+
# :warning: Not intended for production use :warning:
582

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

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

65-
We have no intention of eventually publishing stable artifacts. If you need guarantees,
8+
There is no intention of eventually publishing stable artifacts. If you need any guarantees,
669
please generate your own bindings,
6710
consulting [grpc codegen](https://grpc.io/docs/languages/java/generated-code/#codegen) and
6811
possibly [build.gradle.kts](build.gradle.kts)
69-
70-
## Releasing
71-
72-
See [RELEASING.md](./RELEASING.md)

0 commit comments

Comments
 (0)