Skip to content

Add new section in README on how to publish and test a snapshot release #43

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 4 commits into from
Apr 15, 2025
Merged

Add new section in README on how to publish and test a snapshot release #43

Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
6c8b0e2
Add new section in README on how to publish and test a snapshot release
tuancoltech Apr 13, 2025
68de713
Update README.md
jo-elimu Apr 14, 2025
54e4117
Update README.md
tuancoltech Apr 14, 2025
41c5d6f
Merge branch 'main' into doc/add_snapshot_publish_guide
tuancoltech Apr 14, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
10 changes: 10 additions & 0 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -37,6 +37,16 @@ So, make sure you have Hilt & kapt imported in your projects via below check-lis
```
7. Now you're ready to use the Text to Speech function

### How to publish a snapshot for local development & testing?

1. Change the `libVersion` and `versionCode` in https://github.com/elimu-ai/common-utils/blob/main/utils/build.gradle
2. Under `publishing` -> `repositories` block in the same Gradle script: Replace the existing `maven` repo by `mavenLocal()`
3. Run `./gradlew clean utils:publishReleasePublicationToMavenLocal` from project's root folder
4. In app side: Add `mavenLocal()` to `repositories` block in `build.gradle` script
5. Implement `ai.elimu.common:utils:$snapshot_version` in app's `build.gradle` file
6. You're now ready to test the snapshot!


## How to release a new version?

1. Update versionCode, versionName in `utils/build.gradle` file by increment either major/minor/patch number and merge to `main` (Do not remove the `SNAPSHOT` suffix)
Expand Down
Loading