Skip to content

Commit 41f40b4

Browse files
committed
docs: add version hints and fix SDK references
- Add 'use version from VERSION or Releases' in getting-started, READMEs, versioning and deployment guides - Fix Kotlin SDK coordinates in docs/sdks (io.flagent -> com.flagent:kotlin-client), add Spring Boot note - Fix deployment.ru.md: use VERSION for jar name, add note for config block - Fix faq.ru.md SDK link anchor; fix samples/android README artifact names - Add one-line version note to all SDK READMEs (Kotlin, JS, Swift, Go, Dart, Java, Spring Boot, Koin, Ktor, Flutter, Android/iOS guide) - ci: fix release workflow — use jvmJar for KMP modules (kotlin-client, kotlin-debug-ui), drop non-existent sourcesJar/javadocJar Made-with: Cursor
1 parent c3e45c6 commit 41f40b4

30 files changed

Lines changed: 20058 additions & 355 deletions

File tree

.github/workflows/release.yml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -114,7 +114,7 @@ jobs:
114114
run: |
115115
./gradlew build --no-daemon -x test
116116
./gradlew :backend:distZip --no-daemon
117-
./gradlew :backend:jar :ktor-flagent:jar :kotlin-client:jar :kotlin-client:sourcesJar :kotlin-client:javadocJar :kotlin-enhanced:jvmJar :kotlin-debug-ui:jar :java-client:jar :java-client:sourcesJar :java-client:javadocJar :flagent-spring-boot-starter:jar :flagent-spring-boot-starter:sourcesJar --no-daemon
117+
./gradlew :backend:jar :ktor-flagent:jar :kotlin-client:jvmJar :kotlin-enhanced:jvmJar :kotlin-debug-ui:jvmJar :java-client:jar :java-client:sourcesJar :java-client:javadocJar :flagent-spring-boot-starter:jar :flagent-spring-boot-starter:sourcesJar --no-daemon
118118
119119
- name: Set up Node.js
120120
uses: actions/setup-node@v4

README.md

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -319,6 +319,8 @@ dependencies {
319319
}
320320
```
321321

322+
Replace the version with the value from root [`VERSION`](VERSION) or [Releases](https://github.com/MaxLuxs/Flagent/releases).
323+
322324
Published artifacts: `shared` (KMP), `ktor-flagent`, `kotlin-client`, `kotlin-enhanced`, `kotlin-debug-ui`, `flagent-koin`, `flagent-java-client` (Maven), `flagent-spring-boot-starter`. For public read use a [GitHub PAT](https://github.com/settings/tokens) with `read:packages` (or `GITHUB_TOKEN` in CI). Replace version with the [latest release](https://github.com/MaxLuxs/Flagent/releases).
323325

324326
### Server-Side Integration

README.ru.md

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -181,6 +181,8 @@ dependencies {
181181
}
182182
```
183183

184+
Подставьте версию из корневого [`VERSION`](VERSION) или [Releases](https://github.com/MaxLuxs/Flagent/releases).
185+
184186
Публикуемые артефакты: `shared`, `ktor-flagent`, `kotlin-client`, `kotlin-enhanced`, `kotlin-debug-ui`, `flagent-koin`, `flagent-java-client` (Maven), `flagent-spring-boot-starter`. Версию см. в [релизах](https://github.com/MaxLuxs/Flagent/releases). Чтение: [GitHub PAT](https://github.com/settings/tokens) с `read:packages` или `GITHUB_TOKEN` в CI.
185187

186188
### SDK (все стабильны)

docs/guides/deployment.ru.md

Lines changed: 12 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -79,13 +79,20 @@ open http://localhost:18000
7979
./gradlew :backend:shadowJar
8080
```
8181

82-
Создаётся `backend/build/libs/backend-<version>-all.jar` (например `backend-0.1.6-all.jar`). Запуск:
82+
Создаётся `backend/build/libs/backend-<version>-all.jar`. Подставьте версию из корневого файла `VERSION`. Запуск:
83+
84+
```bash
85+
# из корня репозитория
86+
java -jar backend/build/libs/backend-$(cat VERSION)-all.jar
87+
```
88+
89+
Или вручную, например для версии 0.1.6:
8390

8491
```bash
8592
java -jar backend/build/libs/backend-0.1.6-all.jar
8693
```
8794

88-
Замените `0.1.4` на версию из корневого файла `VERSION`.
95+
Версию см. в корневом файле `VERSION`.
8996

9097
### Конфигурация
9198

@@ -101,9 +108,11 @@ export FLAGENT_DB_DBCONNECTIONSTR=jdbc:postgresql://localhost:5432/flagent?user=
101108
export FLAGENT_LOGRUS_LEVEL=info
102109
export FLAGENT_LOGRUS_FORMAT=json
103110

104-
java -jar backend/build/libs/backend-0.1.6-all.jar
111+
java -jar backend/build/libs/backend-$(cat VERSION)-all.jar
105112
```
106113

114+
(Версию см. в корневом файле `VERSION`.)
115+
107116
## Production настройка
108117

109118
### Конфигурация базы данных

docs/guides/faq.ru.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -73,7 +73,7 @@ PostgreSQL (рекомендуется для production), MySQL, SQLite (тол
7373

7474
## SDK и интеграция
7575

76-
Официальные SDK: Kotlin (JVM, Android, KMP), JavaScript/TypeScript (Node.js, браузер, React), Swift (iOS, macOS, tvOS). Есть Ktor-плагин (`ktor-flagent`) и Spring Boot Starter (`flagent-spring-boot-starter`). См. [Client SDKs](https://github.com/MaxLuxs/Flagent/blob/main/README.md#client-libraries).
76+
Официальные SDK: Kotlin (JVM, Android, KMP), JavaScript/TypeScript (Node.js, браузер, React), Swift (iOS, macOS, tvOS). Есть Ktor-плагин (`ktor-flagent`) и Spring Boot Starter (`flagent-spring-boot-starter`). См. [README — SDKs](https://github.com/MaxLuxs/Flagent/blob/main/README.md#-sdks).
7777

7878
## Производительность
7979

docs/guides/getting-started.md

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -371,6 +371,8 @@ println(result.debugLogs) // See why flag matched or didn't match
371371

372372
## SDK Setup
373373

374+
Use the version from the root [`VERSION`](https://github.com/MaxLuxs/Flagent/blob/main/VERSION) file or [Releases](https://github.com/MaxLuxs/Flagent/releases). Examples below may show a specific version (e.g. `0.1.6`).
375+
374376
### Kotlin/Android
375377

376378
```kotlin

docs/guides/getting-started.ru.md

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -369,6 +369,8 @@ println(result.debugLogs) // Посмотреть, почему флаг сов
369369

370370
## Настройка SDK
371371

372+
Подставьте версию из корневого файла [`VERSION`](https://github.com/MaxLuxs/Flagent/blob/main/VERSION) или [Releases](https://github.com/MaxLuxs/Flagent/releases). В примерах ниже может быть указана конкретная версия (например `0.1.6`).
373+
372374
### Kotlin/Android
373375

374376
```kotlin

docs/guides/versioning.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -18,7 +18,7 @@
1818
# One-time after clone
1919
./scripts/install-hooks.sh
2020

21-
# On release
21+
# On release (replace 0.1.6 with the version you are releasing)
2222
echo "0.1.6" > VERSION
2323
./scripts/sync-version.sh # required
2424
git add -A

docs/guides/versioning.ru.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -18,7 +18,7 @@
1818
# Один раз после клонирования
1919
./scripts/install-hooks.sh
2020

21-
# При релизе
21+
# При релизе (подставьте свою версию вместо 0.1.6)
2222
echo "0.1.6" > VERSION
2323
./scripts/sync-version.sh # обязательно
2424
git add -A

docs/index.html

Lines changed: 19992 additions & 338 deletions
Large diffs are not rendered by default.

0 commit comments

Comments
 (0)