Skip to content

Commit efeeaf1

Browse files
authored
Add documenation to README.md and RELEASING.md (#4)
* add documenation to README.md and RELEASING.md * use kotlin syntax instead of groovy.
1 parent 7fca6a7 commit efeeaf1

File tree

2 files changed

+59
-2
lines changed

2 files changed

+59
-2
lines changed

README.md

Lines changed: 36 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,37 @@
1-
# OpenTelemetry - Protobuf messages
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)
22

3-
Under Construction
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+
## Releasing
36+
37+
See [RELEASING.md](./RELEASING.md)

RELEASING.md

Lines changed: 23 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,23 @@
1+
# Versioning and releasing
2+
3+
Releases of the Java bindings for the OpenTelemetry Protocol (OTLP) follow the same versions
4+
as [releases in opentelemetry-proto](https://github.com/open-telemetry/opentelemetry-proto/releases).
5+
6+
## Starting the release
7+
8+
Upon release of a new [opentelemetry-proto](https://github.com/open-telemetry/opentelemetry-proto) version:
9+
10+
- Open
11+
the ["Release Build" workflow](https://github.com/open-telemetry/opentelemetry-proto-java/actions/workflows/release-build.yml)
12+
in your browser
13+
- Click the button that says "Run workflow" next to the phrase "This workflow has a
14+
`workflow_dispatch` event trigger." and then
15+
- select the `main` branch
16+
- enter the version of the new [opentelemetry-proto](https://github.com/open-telemetry/opentelemetry-proto) release
17+
- click "Run workflow"
18+
19+
A successful workflow run will create:
20+
- a new [tag](https://github.com/open-telemetry/opentelemetry-proto-java/tags)
21+
- a new [release announcement](https://github.com/open-telemetry/opentelemetry-proto-java/releases)
22+
- a new release
23+
on [Maven Central](https://search.maven.org/artifact/io.opentelemetry.proto/opentelemetry-proto)

0 commit comments

Comments
 (0)