Skip to content

Commit 632d50c

Browse files
marcingrzejszczakmarcingrzejszczak
committed
Releasing improvements
1 parent 1b16615 commit 632d50c

File tree

4 files changed

+103
-14
lines changed

4 files changed

+103
-14
lines changed

‎docs/src/main/asciidoc/README.adoc‎

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -125,3 +125,7 @@ include::https://raw.githubusercontent.com/spring-cloud/spring-cloud-build/maste
125125
== Contributing
126126

127127
include::https://raw.githubusercontent.com/spring-cloud/spring-cloud-build/master/docs/src/main/asciidoc/contributing.adoc[]
128+
129+
== Releasing
130+
131+
include::__releasing.adoc[]

‎docs/src/main/asciidoc/__releasing.adoc‎

Lines changed: 65 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,65 @@
1+
=== Bump the versions of all the dependencies
2+
3+
Go to root project's `pom.xml` and update the properties to point to proper dependency versions.
4+
5+
=== Update the project versions
6+
7+
```bash
8+
$ otelVersion="1.0.0-M8" && ./mvnw versions:set -DnewVersion="${otelVersion}" -DgenerateBackupPoms=false && pushd spring-cloud-sleuth-otel-dependencies && ../mvnw versions:set -DnewVersion="${otelVersion}" -DgenerateBackupPoms=false && popd
9+
```
10+
11+
IMPORTANT: Notice that we have to update the `otel-dependencies` module manually.
12+
13+
=== Build the project
14+
15+
IMPORTANT: Remember to add a proper profile. `milestone` for milestones / release candidates, `central` for GA versions. No profile is required for snapshots.
16+
17+
```bash
18+
$ ./mvnw clean install -Pmilestone
19+
```
20+
21+
or
22+
23+
```bash
24+
$ ./mvnw clean install -Pcentral
25+
```
26+
27+
=== Upload the artifacts
28+
29+
```bash
30+
$ ./mvnw deploy -Pmilestone
31+
```
32+
33+
or
34+
35+
```bash
36+
$ ./mvnw deploy -Pcentral
37+
```
38+
39+
=== Commit and tag
40+
41+
```bash
42+
$ ./mvnw versions:commit
43+
$ otelVersion="1.0.0-M8" && ./mvnw versions:set-scm-tag -DnewTag="${otelVersion}"
44+
```
45+
46+
=== Generate and update the docs
47+
48+
```bash
49+
$ ./mvnw clean install -Pdocs -pl docs
50+
$ export otelVersion="1.0.0-M8"
51+
$ temporaryDir="/tmp/sleuth-otel" && rm -rf "${temporaryDir}" && mkdir -p "${temporaryDir}" && cp -r docs/target/generated-docs/* "${temporaryDir}" && git checkout gh-pages && git reset --hard origin/gh-pages && rm -rf "${temporaryDir}/docs/${otelVersion}" && mkdir "${temporaryDir}/docs/${otelVersion}" && cp -rf "${temporaryDir}"/* "${temporaryDir}/docs/${otelVersion}" && git add . && git commit -m "Updated site" && git push origin gh-pages
52+
```
53+
54+
=== Go back to snapshots
55+
56+
```bash
57+
$ otelVersion="1.0.0-SNAPSHOT" && ./mvnw versions:set -DnewVersion="${otelVersion}" -DgenerateBackupPoms=false && pushd spring-cloud-sleuth-otel-dependencies && ../mvnw versions:set -DnewVersion="${otelVersion}" -DgenerateBackupPoms=false && popd
58+
```
59+
60+
=== Commit and push tags
61+
62+
```bash
63+
$ ./mvnw versions:commit
64+
$ git push origin --tags
65+
```

‎docs/src/main/asciidoc/_configprops.adoc‎

Lines changed: 12 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -1,30 +1,28 @@
11
|===
22
|Name | Default | Description
33

4-
|spring.sleuth.otel.config.instrumentation-name | `org.springframework.cloud.spring-cloud-sleuth` | Instrumentation name to be used to find a Tracer.
4+
|spring.sleuth.otel.config.instrumentation-name | | Instrumentation name to be used to find a Tracer.
55
|spring.sleuth.otel.config.instrumentation-version | | Instrumentation version to be used to find a Tracer.
6-
|spring.sleuth.otel.config.max-attrs | `0` | Returns the global default max number of attributes per {@link Span}.
7-
|spring.sleuth.otel.config.max-event-attrs | `0` | Returns the global default max number of attributes per event.
8-
|spring.sleuth.otel.config.max-events | `0` | Returns the global default max number of events per {@link Span}.
9-
|spring.sleuth.otel.config.max-link-attrs | `0` | Returns the global default max number of attributes per link.
10-
|spring.sleuth.otel.config.max-links | `0` | Returns the global default max number of link entries per {@link Span}.
11-
|spring.sleuth.otel.config.trace-id-ratio-based | `0.1` | Sets the global default {@code Sampler} value.
6+
|spring.sleuth.otel.config.max-attrs | | Returns the global default max number of attributes per {@link Span}.
7+
|spring.sleuth.otel.config.max-event-attrs | | Returns the global default max number of attributes per event.
8+
|spring.sleuth.otel.config.max-events | | Returns the global default max number of events per {@link Span}.
9+
|spring.sleuth.otel.config.max-link-attrs | | Returns the global default max number of attributes per link.
10+
|spring.sleuth.otel.config.max-links | | Returns the global default max number of link entries per {@link Span}.
11+
|spring.sleuth.otel.config.trace-id-ratio-based | | Sets the global default {@code Sampler} value.
1212
|spring.sleuth.otel.exporter.jaeger.endpoint | | Sets the Jaeger endpoint to connect to.
1313
|spring.sleuth.otel.exporter.jaeger.timeout | | Timeout in millis.
1414
|spring.sleuth.otel.exporter.otlp.endpoint | | Sets the OTLP endpoint to connect to.
1515
|spring.sleuth.otel.exporter.otlp.headers | | Map of headers to be added.
1616
|spring.sleuth.otel.exporter.otlp.timeout | | Timeout in millis.
17-
|spring.sleuth.otel.exporter.sleuth-span-filter.enabled | `true` | Enables Sleuth span filter.
18-
|spring.sleuth.otel.log.exporter.enabled | `false` | Enable log exporter for OTel.
19-
|spring.sleuth.otel.log.slf4j.enabled | `false` | Enable slf4j support for OTel.
20-
|spring.sleuth.otel.multiple-tracer-configs-detector-enabled | `true` | Enable detection of autoconfiguration for multiple tracers (i.e.: Brave and OTel); only one of them should be used.
17+
|spring.sleuth.otel.exporter.sleuth-span-filter.enabled | | Enables Sleuth span filter.
18+
|spring.sleuth.otel.log.exporter.enabled | | Enable log exporter for OTel.
19+
|spring.sleuth.otel.log.slf4j.enabled | | Enable slf4j support for OTel.
2120
|spring.sleuth.otel.processor.batch.exporter-timeout | | Exporter timeout in millis.
2221
|spring.sleuth.otel.processor.batch.max-export-batch-size | | Max export batch size.
2322
|spring.sleuth.otel.processor.batch.max-queue-size | | Max queue size.
2423
|spring.sleuth.otel.processor.batch.schedule-delay | | Schedule delay in millis.
25-
|spring.sleuth.otel.propagation.composite-text-map-propagator.enabled | `true` | Enable a composite text map propagator that can combine multiple propagation types into a single text map propagator.
26-
|spring.sleuth.otel.propagation.sleuth-baggage.enabled | `true` | Enable propagating baggage in a Sleuth compatible way (baggage key & value pair means e.g. a key & value HTTP pair).
27-
|spring.sleuth.otel.resource.enabled | `true` | Enables default {@link Resource} implementations.
24+
|spring.sleuth.otel.propagation.sleuth-baggage.enabled | | Enables default B3 Sleuth Baggage propagation. This will be automatically turned on when B3 propagation type gets picked.
25+
|spring.sleuth.otel.resource.enabled | | Enables default {@link Resource} implementations.
2826
|spring.zipkin.activemq.message-max-bytes | `100000` | Maximum number of bytes for a given message with spans sent to Zipkin over ActiveMQ.
2927
|spring.zipkin.activemq.queue | `zipkin` | Name of the ActiveMQ queue where spans should be sent to Zipkin.
3028
|spring.zipkin.kafka.topic | `zipkin` | Name of the Kafka topic where spans should be sent to Zipkin.

‎pom.xml‎

Lines changed: 22 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -155,6 +155,28 @@
155155
<plugin>
156156
<artifactId>maven-checkstyle-plugin</artifactId>
157157
</plugin>
158+
<plugin>
159+
<groupId>org.apache.maven.plugins</groupId>
160+
<artifactId>maven-enforcer-plugin</artifactId>
161+
<version>3.0.0-M3</version>
162+
<executions>
163+
<execution>
164+
<id>enforce-no-snapshots</id>
165+
<goals>
166+
<goal>enforce</goal>
167+
</goals>
168+
<configuration>
169+
<rules>
170+
<requireReleaseDeps>
171+
<onlyWhenRelease>true</onlyWhenRelease>
172+
<message>No Snapshots Allowed!</message>
173+
</requireReleaseDeps>
174+
</rules>
175+
<fail>true</fail>
176+
</configuration>
177+
</execution>
178+
</executions>
179+
</plugin>
158180
</plugins>
159181
</build>
160182

0 commit comments

Comments
 (0)