Skip to content

Commit c8f0ba9

Browse files
committed
Gardening: Update Readme for new branching/tagging strategy
Change-Id: I8b70c13465720a23cf2ed3b9d08e9c792cec08bf Reviewed-on: https://review.couchbase.org/c/couchbase-jvm-clients/+/232296 Tested-by: David Nault <[email protected]> Reviewed-by: David Nault <[email protected]>
1 parent 53c1d27 commit c8f0ba9

File tree

1 file changed

+27
-9
lines changed

1 file changed

+27
-9
lines changed

README.md

Lines changed: 27 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -7,9 +7,9 @@
77

88
[![license](https://img.shields.io/github/license/couchbase/couchbase-jvm-clients?color=brightgreen)](https://opensource.org/licenses/Apache-2.0)
99

10-
[![java-client](https://img.shields.io/maven-central/v/com.couchbase.client/java-client?color=brightgreen&label=java-client)](https://search.maven.org/artifact/com.couchbase.client/java-client)
11-
[![scala-client](https://img.shields.io/maven-central/v/com.couchbase.client/scala-client_2.12?color=brightgreen&label=scala-client)](https://search.maven.org/artifact/com.couchbase.client/scala-client_2.12)
12-
[![kotlin-client](https://img.shields.io/maven-central/v/com.couchbase.client/kotlin-client?color=brightgreen&label=kotlin-client)](https://search.maven.org/artifact/com.couchbase.client/kotlin-client)
10+
[![java-client](https://img.shields.io/maven-central/v/com.couchbase.client/java-client?color=brightgreen&label=java-client)](https://central.sonatype.com/artifact/com.couchbase.client/java-client)
11+
[![scala-client](https://img.shields.io/maven-central/v/com.couchbase.client/scala-client_2.12?color=brightgreen&label=scala-client)](https://central.sonatype.com/artifact/com.couchbase.client/scala-client_2.12)
12+
[![kotlin-client](https://img.shields.io/maven-central/v/com.couchbase.client/kotlin-client?color=brightgreen&label=kotlin-client)](https://central.sonatype.com/artifact/com.couchbase.client/kotlin-client)
1313

1414
This repository contains the third generation of the Couchbase SDKs on the JVM ("SDK 3").
1515

@@ -36,7 +36,7 @@ and [Kotlin](https://docs.couchbase.com/kotlin-sdk/current/hello-world/overview.
3636
These include getting started guides.
3737

3838
## Building
39-
Stable releases are published on [maven central](https://search.maven.org/search?q=com.couchbase.client).
39+
Stable releases are published on [Maven Central](https://central.sonatype.com/namespace/com.couchbase.client).
4040

4141
You can always also just build it from source, using any JDK 17+:
4242

@@ -82,14 +82,32 @@ They are not included in the build by default as they require a) JDK 17 and b) t
8282
To use a performer, uncomment the lines in the top-level pom.xml after 'Uncomment next lines to include the FIT performers', and reload the Maven config.
8383
Then run one of the performers in an IDE.
8484
85-
### Branches & Release Trains
85+
### Branches & Tags
8686
87-
Since this monorepo houses different versions of different artifacts, release train names have been chosen
88-
to identify a collection of releases that belong to the same train.
87+
Since version 3.9.0, this repository uses a mono-versioning strategy.
88+
Each component in the monorepo is released with the same version number.
8989
90-
These trains are named after historic computers for your delight.
90+
Releases are tagged by version number.
91+
For example, version 3.9.0 is tagged as `3.9.0`.
9192
92-
Tags in each branch are named `branchname-ga` for the initial GA release, and then subsequently `branchname-sr-n` for
93+
The `master` branch is where development for the next minor release happens.
94+
95+
Maintenance branches are named `<major>.<minor>.x`.
96+
For example, the maintenance branch for minor version 3.9 is named `3.9.x`.
97+
98+
Instead of committing directly to a maintenance branch, first commit to `master` and then cherry-pick to the maintenance branch if possible.
99+
100+
#### Prior to version 3.9.0
101+
102+
Component versions before 3.9.0 were tagged as `<component>-<version>`.
103+
For example, to check out the code for version 3.6.0 of the Java client, use tag `java-client-3.6.0`.
104+
105+
Before mono-versioning, this repository used release train code names
106+
to identify a collection of related release versions.
107+
108+
These trains were named after historic computers for your delight.
109+
110+
Tags in each branch were named `branchname-ga` for the initial GA release, and then subsequently `branchname-sr-n` for
93111
each service release. See the tag information for specifics of what's in there.
94112

95113
- [Titan](https://en.wikipedia.org/wiki/Titan_(supercomputer))

0 commit comments

Comments
 (0)