Skip to content

Commit bbbf2bc

Browse files
authored
Post release 0.15.0 version/docs fixes (#1233)
* update versions in READMEs in main * automate the README version updates in the main branch PR as well * fix otel android version * use sonatype instead of maven to fix link checker getting 403. * insert version and use sonatype url for bytebuddy version search
1 parent c5c9399 commit bbbf2bc

File tree

15 files changed

+28
-26
lines changed

15 files changed

+28
-26
lines changed

.github/workflows/prepare-release-branch.yml

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -116,6 +116,13 @@ jobs:
116116
- name: Update version in README
117117
run: sed -Ei "s/(\"io.opentelemetry.android:opentelemetry-android-bom:).*\"/\1${VERSION}-alpha\"/" README.md
118118

119+
- name: Update instrumentation README.md versions
120+
run: |
121+
for f in $(find instrumentation -name README.md) ; do
122+
echo Updating version in $f;
123+
sed -Ei "s/(\(\"io\.opentelemetry\.android.*):[[:digit:]]+\.[[:digit:]]+\.[[:digit:]](-alpha)?\"/\1:${VERSION}-alpha\"/" $f
124+
done
125+
119126
- name: Update the change log on main
120127
run: |
121128
# the actual release date on main will be updated at the end of the release workflow

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:0.13.0-alpha")
51+
implementation("io.opentelemetry.android.instrumentation:activity:0.15.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:0.13.0-alpha")
41-
byteBuddy("io.opentelemetry.android.instrumentation:android-log-agent:0.13.0-alpha") // <2>
40+
implementation("io.opentelemetry.android.instrumentation:android-log-library:0.15.0-alpha")
41+
byteBuddy("io.opentelemetry.android.instrumentation:android-log-agent:0.15.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:0.13.0-alpha")
42+
implementation("io.opentelemetry.android.instrumentation:anr:0.15.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:0.13.0-alpha")
43+
implementation("io.opentelemetry.android.instrumentation:compose-click:0.15.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:0.13.0-alpha")
38+
implementation("io.opentelemetry.android.instrumentation:crash:0.15.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:0.13.0-alpha")
36+
implementation("io.opentelemetry.android.instrumentation:fragment:0.15.0-alpha")
3737
```

instrumentation/httpurlconnection/README.md

Lines changed: 4 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -37,9 +37,7 @@ Spans won't be automatically ended and reported otherwise. If any of your URLCon
3737
3838
### Add these dependencies to your project
3939

40-
Replace `AUTO_HTTP_URL_INSTRUMENTATION_VERSION` with the [latest release](https://central.sonatype.com/search?q=g%3Aio.opentelemetry.android++a%3Ahttpurlconnection-library&smo=true).
41-
42-
Replace `BYTEBUDDY_VERSION` with the [latest release](https://search.maven.org/search?q=g:net.bytebuddy%20AND%20a:byte-buddy).
40+
Replace `BYTEBUDDY_VERSION` with the [latest release](https://central.sonatype.com/artifact/net.bytebuddy/byte-buddy-gradle-plugin/versions).
4341

4442
#### Byte buddy compilation plugin
4543

@@ -54,16 +52,16 @@ plugins {
5452
#### Project dependencies
5553

5654
```kotlin
57-
implementation("io.opentelemetry.android.instrumentation:httpurlconnection-library:AUTO_HTTP_URL_INSTRUMENTATION_VERSION")
58-
byteBuddy("io.opentelemetry.android.instrumentation:httpurlconnection-agent:AUTO_HTTP_URL_INSTRUMENTATION_VERSION")
55+
implementation("io.opentelemetry.android.instrumentation:httpurlconnection-library:0.15.0-alpha")
56+
byteBuddy("io.opentelemetry.android.instrumentation:httpurlconnection-agent:0.15.0-alpha")
5957
```
6058

6159
### Configurations
6260

6361
#### Scheduling Harvester Thread
6462

6563
To schedule a periodically running thread to conclude/report spans on any unreported, idle connections, add the below code in the function where your application starts ( that could be onCreate() method of first Activity/Fragment/Service):
66-
```Java
64+
```java
6765
HttpUrlInstrumentation instrumentation = AndroidInstrumentationLoader.getInstrumentation(HttpUrlInstrumentation.class);
6866
instrumentation.setConnectionInactivityTimeoutMs(customTimeoutValue); //This is optional. Replace customTimeoutValue with a long data type value which denotes the connection inactivity timeout in milli seconds. Defaults to 10000ms
6967
Executors.newSingleThreadScheduledExecutor().scheduleWithFixedDelay(instrumentation.getReportIdleConnectionRunnable(), 0, instrumentation.getReportIdleConnectionInterval(), TimeUnit.MILLISECONDS);

instrumentation/network/README.md

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

4848
```kotlin
49-
implementation("io.opentelemetry.android.instrumentation:network:0.13.0-alpha")
49+
implementation("io.opentelemetry.android.instrumentation:network:0.15.0-alpha")
5050
```

instrumentation/okhttp3-websocket/README.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -22,6 +22,6 @@ plugins {
2222
### Adding dependencies
2323

2424
```kotlin
25-
implementation("io.opentelemetry.android.instrumentation:okhttp3-websocket-library:0.13.0-alpha")
26-
byteBuddy("io.opentelemetry.android.instrumentation:okhttp3-websocket-agent:0.13.0-alpha")
25+
implementation("io.opentelemetry.android.instrumentation:okhttp3-websocket-library:0.15.0-alpha")
26+
byteBuddy("io.opentelemetry.android.instrumentation:okhttp3-websocket-agent:0.15.0-alpha")
2727
```

0 commit comments

Comments
 (0)