Skip to content

Commit 30d02fa

Browse files
abueideclaude
andauthored
docs: fix stale release, contributing, and Java-compat instructions (#312)
- RELEASING.md: the default branch is `main`, not `master`; the snapshot workflow only fires on push to `main`. Update the merge-target references in steps 9 and 10. - CONTRIBUTING.md: the example apps live under `samples/`, not `/example/`, and `installDebug` must target a sample module (`./gradlew :samples:kotlin-android-app:installDebug`). Also replace the React-Native-template commit examples (class-components-to-hooks, detox) with Kotlin-relevant ones. - JAVA_COMPAT.md: the library ships on Maven Central under `com.segment.analytics.kotlin` (current 1.25.0), not jitpack. Replace the jitpack badge/repository/coordinates with Maven Central and drop the stale 'Pilot phase' notice. Co-authored-by: Claude Opus 4.8 <noreply@anthropic.com>
1 parent a14649b commit 30d02fa

3 files changed

Lines changed: 14 additions & 18 deletions

File tree

CONTRIBUTING.md

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -10,11 +10,11 @@ To get started with the project
1010
- clone this repository
1111
- import the project into Android Studio
1212

13-
While developing, you can run the [example app](/example/) to test your changes.
13+
While developing, you can run one of the [example apps](/samples/) to test your changes.
1414
- You can do this via the IDE itself using the `Run app` button in the toolbar
15-
- You can install the debug version of the app using the gradle command:
15+
- You can install the debug version of an app using the gradle command (targeting a specific sample module):
1616
```
17-
./gradlew installDebug
17+
./gradlew :samples:kotlin-android-app:installDebug
1818
```
1919

2020
Remember to add tests for your change if possible. Run the unit tests:
@@ -30,9 +30,9 @@ We follow the [conventional commits specification](https://www.conventionalcommi
3030

3131
- `fix`: bug fixes, e.g. fix crash due to deprecated method.
3232
- `feat`: new features, e.g. add new method to the module.
33-
- `refactor`: code refactor, e.g. migrate from class components to hooks.
34-
- `docs`: changes into documentation, e.g. add usage example for the module..
35-
- `test`: adding or updating tests, eg add integration tests using detox.
33+
- `refactor`: code refactor, e.g. extract a helper or restructure a plugin.
34+
- `docs`: changes into documentation, e.g. add usage example for the module.
35+
- `test`: adding or updating tests, e.g. add unit tests for a new plugin.
3636
- `chore`: tooling changes, e.g. change CI config.
3737

3838
### Linting and tests

JAVA_COMPAT.md

Lines changed: 6 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -1,12 +1,8 @@
11
# Analytics-Kotlin Java Compatibility
2-
[![](https://jitpack.io/v/segmentio/analytics-kotlin.svg)](https://jitpack.io/#segmentio/analytics-kotlin)
2+
[![maven](https://img.shields.io/maven-central/v/com.segment.analytics.kotlin/android)](https://repo1.maven.org/maven2/com/segment/analytics/kotlin/)
33

44
The hassle-free way to add Segment analytics to your kotlin app (Android/JVM).
55

6-
NOTE: This project is currently in the Pilot phase and is covered by Segment's [First Access & Beta Preview Terms](https://segment.com/legal/first-access-beta-preview/). We encourage you
7-
to try out this new library. Please provide feedback via Github issues/PRs, and feel free to submit pull requests. This library will eventually
8-
supplant our `analytics-android` library.
9-
106
NOTE: This document serves as an explanation of usage of this `analytics-kotlin` library for pure Java codebase. For the sample usages in Kotlin and more detailed architectural explanation, please refer to our main [README.md doc](README.md).
117

128
## Table of Contents
@@ -35,19 +31,19 @@ NOTE: This document serves as an explanation of usage of this `analytics-kotlin`
3531
- [License](#license)
3632

3733
## Installation
38-
For our pilot phase, we will be using [jitpack](https://jitpack.io/#segmentio/analytics-kotlin) to distribute the library
34+
The library is published to Maven Central under the `com.segment.analytics.kotlin` group.
3935
<details open>
4036
<summary>Android</summary>
4137
<br>
4238
In your app's build.gradle file add the following
4339

4440
```groovy
4541
repositories {
46-
maven { url 'https://jitpack.io' }
42+
mavenCentral()
4743
}
4844
4945
dependencies {
50-
implementation 'com.github.segmentio.analytics-kotlin:android:+'
46+
implementation 'com.segment.analytics.kotlin:android:1.25.0'
5147
}
5248
```
5349

@@ -60,11 +56,11 @@ dependencies {
6056
In your app's build.gradle file add the following
6157
```groovy
6258
repositories {
63-
maven { url 'https://jitpack.io' }
59+
mavenCentral()
6460
}
6561
6662
dependencies {
67-
implementation 'com.github.segmentio.analytics-kotlin:core:+'
63+
implementation 'com.segment.analytics.kotlin:core:1.25.0'
6864
}
6965
```
7066
</details>

RELEASING.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -15,7 +15,7 @@ Releasing
1515
6. Upgrade to next version by changing version in `gradle.properties`
1616
7. `git commit -am "Prepare snapshot X.Y.Z-SNAPSHOT"`
1717
8. `git push && git push --tags`
18-
9. Create a PR to merge the new branch into `master`
18+
9. Create a PR to merge the new branch into `main`
1919
10. The CI pipeline will recognize the tag and upload, close and promote the artifacts automatically, and generate changelog automatically
2020

2121
Example (stable release)
@@ -30,4 +30,4 @@ Example (stable release)
3030
7. Change VERSION_NAME = 1.3.2 (next higher version)
3131
8. `git commit -am "Prepare snapshot 1.3.2-SNAPSHOT"`
3232
9. `git push && git push --tags`
33-
10. Merging PR master will create a snapshot release 1.3.2-SNAPSHOT and tag push will create stable release 1.3.1
33+
10. Merging the PR into `main` will create a snapshot release 1.3.2-SNAPSHOT and the tag push will create stable release 1.3.1

0 commit comments

Comments
 (0)