Skip to content

Commit bffac27

Browse files
breedx-splkbreedx-splk
authored
Prepare v1.0.0 (#1498)
* update version * update changelog * update readmes * add a one-off release workflow for the v1.0.0 release.
1 parent a6cde67 commit bffac27

18 files changed

Lines changed: 108 additions & 25 deletions

File tree

‎.github/workflows/release-1.0.0.yml‎

Lines changed: 56 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,56 @@
1+
---
2+
name: "Special one-off 1.0.0 release"
3+
4+
on:
5+
workflow_dispatch:
6+
7+
permissions:
8+
contents: read
9+
10+
jobs:
11+
release-1-0-0:
12+
permissions:
13+
contents: write # for creating the release
14+
name: "release v1.0.0"
15+
runs-on: ubuntu-latest
16+
steps:
17+
- run: |
18+
if [[ $GITHUB_REF_NAME != release/v1.0.x ]]; then
19+
echo This workflow can only be run against release/v1.0.x branch
20+
exit 1
21+
fi
22+
- uses: actions/checkout@8e8c483db84b4bee98b60c0593521ed34d9990e8 # v6.0.1
23+
- name: Set environment variables
24+
run: |
25+
# otel instrumentation version comes in through alpha bom
26+
inst_version=$(./gradlew --console=plain android-agent:dependencies | \
27+
grep 'io.opentelemetry.instrumentation:opentelemetry-instrumentation-api ' | \
28+
sed -e "s/.* -> //" | sed -e "s/ .*//" | grep '^\d' | \
29+
sort | head -1)
30+
# otel-java core libs are transient deps thru instrumentation boms
31+
sdk_version=$(./gradlew --console=plain android-agent:dependencies | \
32+
grep 'io.opentelemetry:opentelemetry-api ' | \
33+
sed -e "s/.* -> //" | sed -e "s/ .*//" | \
34+
sort | head -1)
35+
36+
echo "VERSION=1.0.0" >> $GITHUB_ENV
37+
echo "INST_VERSION=$inst_version" >> $GITHUB_ENV
38+
echo "OTEL_SDK_VERSION=$sdk_version" >> $GITHUB_ENV
39+
40+
41+
- name: Set up JDK for running Gradle
42+
uses: actions/setup-java@f2beeb24e141e01a676f977032f5a29d81c9e27e # v5.1.0
43+
with:
44+
distribution: temurin
45+
java-version: 21
46+
47+
- name: Build and publish artifacts
48+
run: ./gradlew publishToSonatype closeAndReleaseSonatypeStagingRepository -Pfinal=true --no-build-cache --no-configuration-cache --no-parallel
49+
env:
50+
SONATYPE_USER: ${{ secrets.SONATYPE_USER }}
51+
SONATYPE_KEY: ${{ secrets.SONATYPE_KEY }}
52+
GPG_PRIVATE_KEY: ${{ secrets.GPG_PRIVATE_KEY }}
53+
GPG_PASSWORD: ${{ secrets.GPG_PASSWORD }}
54+
55+
- name: "Great success!"
56+
run: echo "v1.0.0 release complete"

‎CHANGELOG.md‎

Lines changed: 14 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,19 @@
11
# OpenTelemetry Android Changelog
22

3+
## Version 1.0.0 (2026-01-07)
4+
5+
⭐ Promote rc.1 to v1.0.0.
6+
7+
This release promotes v1.0.0-rc1 to v1.0.0 without any additional changes.
8+
This release also denotes the first stable version of the OpenTelemetry
9+
Android Agent!
10+
11+
Going forward, we will prevent breaking changes to the agent API until
12+
the next major version. Other modules, including instrumentation, are still
13+
marked as alpha and will each have an individual trajectory toward stability.
14+
15+
Thanks to everyone involved in making this stable release a success!
16+
317
## Version 1.0.0-rc.1 (2025-11-25)
418

519
Good news, everyone! This denotes the first "stable" release candidate (`rc.1`)

‎README.md‎

Lines changed: 19 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -18,6 +18,9 @@ auto-instrumentation of Android apps for real user monitoring (RUM).
1818
While this project isn't 100% Kotlin, it has a "Kotlin-First" policy where usage in Kotlin-based Android apps will be prioritized in terms
1919
of API and idioms. More details about this policy can be found [here](./docs/KOTLIN_FIRST.md).
2020

21+
> [!IMPORTANT]
22+
> We are currently seeking additional contributors! See [Contributing](#contributing) for details.
23+
2124
# Getting Started
2225

2326
> If your project's minSdk is lower than 26, then you must enable
@@ -40,7 +43,7 @@ from all other opentelemetry dependencies:
4043
```kotlin
4144
dependencies {
4245
//...
43-
api(platform("io.opentelemetry.android:opentelemetry-android-bom:0.16.0-alpha"))
46+
api(platform("io.opentelemetry.android:opentelemetry-android-bom:1.0.0-alpha"))
4447
implementation("io.opentelemetry.android:android-agent") // Version is resolved through the BOM
4548
//...
4649
}
@@ -133,10 +136,20 @@ See the following pages for details about the related topics:
133136

134137
# Contributing
135138

136-
For an overview of how to contribute, see the contributing guide in [CONTRIBUTING.md](CONTRIBUTING.md).
139+
We are currently resource constrained and are actively seeking new contributors interested in working towards [approver](https://github.com/open-telemetry/community/blob/main/guides/contributor/membership.md#approver) / [maintainer](https://github.com/open-telemetry/community/blob/main/guides/contributor/membership.md#maintainer) roles.
140+
In addition to the documentation for approver / maintainer roles and the [contributing](./CONTRIBUTING.md) guide, here are some additional notes on engaging:
141+
142+
- [Pull request](https://github.com/open-telemetry/opentelemetry-android/pulls) reviews are equally or more helpful than code contributions. Comments and approvals are valuable with or without a formal project role. They're also a great forcing function to explore a fairly complex codebase.
143+
- Attending the [Android: SDK + Automatic Instrumentation](https://github.com/open-telemetry/community?tab=readme-ov-file#implementation-sigs) Special Interest Group (SIG) is a great way to get to know community members and learn about project priorities.
144+
- Issues labeled [help wanted](https://github.com/open-telemetry/opentelemetry-android/issues?q=is%3Aopen+is%3Aissue+label%3A%22help+wanted%22) are project priorities. Code contributions (or pull request reviews when a PR is linked) for these issues are particularly important.
145+
- Triaging / responding to new issues and discussions is a great way to engage with the project.
146+
- We are available in the [#otel-android](https://cloud-native.slack.com/archives/C05J0T9K27Q) channel in the [CNCF Slack](https://slack.cncf.io/). Please join us there for further discussions.
147+
148+
### Thanks to all of our contributors!
137149

138-
We are also available in the [#otel-android](https://cloud-native.slack.com/archives/C05J0T9K27Q)
139-
channel in the [CNCF Slack](https://slack.cncf.io/). Please join us there for further discussions.
150+
<a href="https://github.com/open-telemetry/opentelemetry-android/graphs/contributors">
151+
<img alt="Repo contributors" src="https://contrib.rocks/image?repo=open-telemetry/opentelemetry-android" />
152+
</a>
140153

141154
## Maintainers
142155

@@ -157,6 +170,6 @@ For more information about the Approver role, see the [community repository](htt
157170

158171
[ci-url]: https://github.com/open-telemetry/opentelemetry-android/actions?query=workflow%3Abuild+branch%3Amain
159172

160-
[maven-image]: https://maven-badges.sml.io/maven-central/io.opentelemetry.android/android-agent/badge.svg
173+
[maven-image]: https://img.shields.io/maven-central/v/io.opentelemetry.android/android-agent.svg
161174

162-
[maven-url]: https://maven-badges.sml.io/maven-central/io.opentelemetry.android/android-agent
175+
[maven-url]: https://central.sonatype.com/artifact/io.opentelemetry.android/android-agent

‎gradle.properties‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -23,5 +23,5 @@ android.useAndroidX=true
2323

2424
android.minSdk=21
2525
android.compileSdk=36
26-
version=1.0.0-rc.1
26+
version=1.0.0
2727
group=io.opentelemetry.android

‎instrumentation/activity/README.md‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -48,5 +48,5 @@ manually install this instrumentation by following the steps below.
4848
### Adding dependencies
4949

5050
```kotlin
51-
implementation("io.opentelemetry.android.instrumentation:activity:1.0.0-rc.1-alpha")
51+
implementation("io.opentelemetry.android.instrumentation:activity:1.0.0-alpha")
5252
```

‎instrumentation/android-log/README.md‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -37,6 +37,6 @@ plugins {
3737
### Adding dependencies
3838

3939
```kotlin
40-
implementation("io.opentelemetry.android.instrumentation:android-log-library:1.0.0-rc.1-alpha")
41-
byteBuddy("io.opentelemetry.android.instrumentation:android-log-agent:1.0.0-rc.1-alpha") // <2>
40+
implementation("io.opentelemetry.android.instrumentation:android-log-library:1.0.0-alpha")
41+
byteBuddy("io.opentelemetry.android.instrumentation:android-log-agent:1.0.0-alpha") // <2>
4242
```

‎instrumentation/anr/README.md‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -39,5 +39,5 @@ manually install this instrumentation by following the steps below.
3939
### Adding dependencies
4040

4141
```kotlin
42-
implementation("io.opentelemetry.android.instrumentation:anr:1.0.0-rc.1-alpha")
42+
implementation("io.opentelemetry.android.instrumentation:anr:1.0.0-alpha")
4343
```

‎instrumentation/compose/click/README.md‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -40,5 +40,5 @@ This instrumentation produces the following telemetry:
4040
### Adding dependencies
4141

4242
```kotlin
43-
implementation("io.opentelemetry.android.instrumentation:compose-click:1.0.0-rc.1-alpha")
43+
implementation("io.opentelemetry.android.instrumentation:compose-click:1.0.0-alpha")
4444
```

‎instrumentation/crash/README.md‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -35,5 +35,5 @@ manually install this instrumentation by following the steps below.
3535
### Adding dependencies
3636

3737
```kotlin
38-
implementation("io.opentelemetry.android.instrumentation:crash:1.0.0-rc.1-alpha")
38+
implementation("io.opentelemetry.android.instrumentation:crash:1.0.0-alpha")
3939
```

‎instrumentation/fragment/README.md‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -33,5 +33,5 @@ manually install this instrumentation by following the steps below.
3333
### Adding dependencies
3434

3535
```kotlin
36-
implementation("io.opentelemetry.android.instrumentation:fragment:1.0.0-rc.1-alpha")
36+
implementation("io.opentelemetry.android.instrumentation:fragment:1.0.0-alpha")
3737
```

0 commit comments

Comments
 (0)