Skip to content

Commit c6d96b4

Browse files
committed
Update composite build description
1 parent 2f56452 commit c6d96b4

File tree

1 file changed

+17
-24
lines changed

1 file changed

+17
-24
lines changed

settings.gradle

Lines changed: 17 additions & 24 deletions
Original file line numberDiff line numberDiff line change
@@ -3,44 +3,37 @@ rootProject.name='android-chat-tutorial'
33

44

55
/*
6-
compositeBuild allow you to easily work on multiple projects at once
7-
you can use the debugger and edit code as if it was a single project
8-
this replaces the need to use mavenLocal publish commands and edit versions
9-
android studio also supports this gradle feature
10-
to work you need to have the client, livedata and main repo in the same top level folder, ie
11-
folder
12-
- stream-chat-android-client
13-
- stream-chat-android-livedata
6+
Composite builds allow you to easily work on multiple projects at once.
7+
To include the SDK repository as a composite build for the tutorial (so that
8+
the version of the SDK currently in the repository can be used here), they need
9+
to be in the same top level folder:
10+
- android-chat-tutorial
1411
- stream-chat-android
15-
add/remove the project .composite file to enable/disable (this file should is added to the gitignore)
12+
13+
Add / remove the project .composite file in the root of the SDK project to
14+
enable / disable composite builds.
15+
1616
Enabling composite builds:
17-
open the stream-chat-android project
18-
> touch ../stream-chat-android-livedata/.composite
19-
> rerun the gradle sync in your editor
20-
> the livedata folder will show up in your stream-chat-android project
17+
> touch ../stream-chat-android/.composite
18+
> Run Gradle sync
19+
2120
Disabling composite builds
22-
open the stream-chat-android project
23-
> rm ../stream-chat-android-livedata/.composite
24-
> rerun the gradle sync in your editor
25-
> the livedata folder will no longer show up in your stream-chat-android project
21+
> rm ../stream-chat-android/.composite
22+
> Run Gradle sync
2623
*/
27-
2824
if (new File(rootDir, '../stream-chat-android/.composite').exists()) {
2925

3026
includeBuild("../stream-chat-android") {
27+
// module spec is not validated, if you get it wrong you just dont get a local version of the module
28+
// project spec is validated, if you get it wrong you get an error
3129
dependencySubstitution {
32-
// project spec is validated, if you get it wrong you get an error
33-
// module spec is not validated, if you get it wrong you just dont get a local version of the module
30+
3431
substitute(module("io.getstream:stream-chat-android-ui-components:")).with(project(":stream-chat-android-ui-components"))
3532
}
3633
dependencySubstitution {
37-
// project spec is validated, if you get it wrong you get an error
38-
// module spec is not validated, if you get it wrong you just dont get a local version of the module
3934
substitute(module("io.getstream:stream-chat-android-client:")).with(project(":stream-chat-android-client"))
4035
}
4136
dependencySubstitution {
42-
// project spec is validated, if you get it wrong you get an error
43-
// module spec is not validated, if you get it wrong you just dont get a local version of the module
4437
substitute(module("io.getstream:stream-chat-android-offline:")).with(project(":stream-chat-android-offline"))
4538
}
4639
}

0 commit comments

Comments
 (0)