Skip to content

Commit cf16e7b

Browse files
committed
docs: Create Version Management Guide and bump versions
- Add `VERSION_MANAGEMENT_GUIDE.md` with comprehensive instructions for updating versions and triggering CI/CD workflows for Android, Desktop, and iOS platforms. - Update `AI_AGENT_GUIDE.md` and `docs/README.md` to link to the new guide. - Bump Android version: - `versionCode`: 841 → 842 - `versionName`: "8.4.1" → "8.4.2" - Bump Desktop version: - `packageVersion`: "3.0.0" → "4.0.0" - Bump iOS version: - `MARKETING_VERSION`: 3.0 → 4.0 - `CFBundleShortVersionString`: "3.0" → "4.0"
1 parent 56a3f8b commit cf16e7b

7 files changed

Lines changed: 404 additions & 6 deletions

File tree

app/android/build.gradle.kts

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -24,8 +24,8 @@ android {
2424
applicationId = "com.softartdev.noteroom"
2525
minSdk = libs.versions.minSdk.get().toInt()
2626
targetSdk = libs.versions.targetSdk.get().toInt()
27-
versionCode = 841
28-
versionName = "8.4.1"
27+
versionCode = 842
28+
versionName = "8.4.2"
2929
testInstrumentationRunner = "androidx.test.runner.AndroidJUnitRunner"
3030
testInstrumentationRunnerArguments["clearPackageData"] = "true"
3131
vectorDrawables.useSupportLibrary = true

app/desktop/build.gradle.kts

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -49,7 +49,7 @@ compose.desktop {
4949
nativeDistributions {
5050
targetFormats(TargetFormat.Dmg, TargetFormat.Msi, TargetFormat.Deb)
5151
packageName = "Note Delight"
52-
packageVersion = "3.0.0"
52+
packageVersion = "4.0.0"
5353
description = "Note app with encryption"
5454
copyright = "© 2023 SoftArtDev"
5555
macOS.iconFile.set(project.file("src/jvmMain/resources/app_icon.icns"))

app/iosApp/iosApp.xcodeproj/project.pbxproj

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -473,7 +473,7 @@
473473
"$(inherited)",
474474
"@executable_path/Frameworks",
475475
);
476-
MARKETING_VERSION = 3.0;
476+
MARKETING_VERSION = 4.0;
477477
OTHER_LDFLAGS = (
478478
"$(inherited)",
479479
"-ObjC",
@@ -514,7 +514,7 @@
514514
"$(inherited)",
515515
"@executable_path/Frameworks",
516516
);
517-
MARKETING_VERSION = 3.0;
517+
MARKETING_VERSION = 4.0;
518518
OTHER_LDFLAGS = (
519519
"$(inherited)",
520520
"-ObjC",

app/iosApp/iosApp/Info.plist

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -22,7 +22,7 @@
2222
<key>CFBundlePackageType</key>
2323
<string>$(PRODUCT_BUNDLE_PACKAGE_TYPE)</string>
2424
<key>CFBundleShortVersionString</key>
25-
<string>3.0</string>
25+
<string>4.0</string>
2626
<key>CFBundleVersion</key>
2727
<string>17</string>
2828
<key>LSRequiresIPhoneOS</key>

docs/AI_AGENT_GUIDE.md

Lines changed: 16 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -19,6 +19,21 @@ This guide is specifically written for AI agents working on the NoteDelight code
1919
./gradlew :app:web:wasmJsBrowserDevelopmentRun --continuous # Web app
2020
```
2121

22+
### Version Management Quick Reference
23+
24+
```bash
25+
# Update versions in all platform files, then:
26+
git add app/*/build.gradle.kts app/iosApp/iosApp.xcodeproj/project.pbxproj app/iosApp/iosApp/Info.plist
27+
git commit -m "chore: bump version to X.Y.Z"
28+
29+
# Trigger CI/CD workflows:
30+
git tag android/vX.Y.Z && git push origin android/vX.Y.Z
31+
git tag desktop/vX.Y.Z && git push origin desktop/vX.Y.Z
32+
git tag ios/vX.Y.Z && git push origin ios/vX.Y.Z
33+
```
34+
35+
**See [VERSION_MANAGEMENT_GUIDE.md](VERSION_MANAGEMENT_GUIDE.md) for detailed instructions.**
36+
2237
## Understanding the Codebase
2338

2439
### Module Hierarchy (Dependency Order)
@@ -528,6 +543,7 @@ Tests often show how to use code correctly. Look at:
528543
- **Architecture**: [ARCHITECTURE.md](ARCHITECTURE.md)
529544
- **Contributing**: [CONTRIBUTING.md](../CONTRIBUTING.md)
530545
- **Testing**: [TESTING_GUIDE.md](TESTING_GUIDE.md)
546+
- **Version Management**: [VERSION_MANAGEMENT_GUIDE.md](VERSION_MANAGEMENT_GUIDE.md)
531547

532548
## Quick Decision Tree
533549

docs/README.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -50,6 +50,7 @@ Each module has its own detailed README.md:
5050
- **Development & Code Style**[CONTRIBUTING.md](../CONTRIBUTING.md)
5151
- **Testing**[TESTING_GUIDE.md](TESTING_GUIDE.md)
5252
- **AI Agent Tasks**[AI_AGENT_GUIDE.md](AI_AGENT_GUIDE.md)
53+
- **Version Management & CI/CD**[VERSION_MANAGEMENT_GUIDE.md](VERSION_MANAGEMENT_GUIDE.md)
5354
- **Platform-Specific** → Module READMEs in `app/` directories
5455
- **Data & Persistence** → Module READMEs in `core/data/` directories
5556

0 commit comments

Comments
 (0)