Skip to content

Commit 9fbbc12

Browse files
Add Gradle plugin repository setup instructions to docs
Updated documentation to include instructions for configuring pluginManagement repositories in settings.gradle.kts when using the KTale Gradle plugin. This helps users resolve the plugin from the correct repositories.
1 parent ba70686 commit 9fbbc12

File tree

3 files changed

+45
-0
lines changed

3 files changed

+45
-0
lines changed

docs/getting-started.mdx

Lines changed: 15 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -18,6 +18,21 @@ dependencies {
1818
}
1919
```
2020

21+
## Gradle plugin repositories (if using `cc.modlabs.ktale-deps`)
22+
23+
If you use the KTale Gradle plugin (`cc.modlabs.ktale-deps`), ensure your build can resolve it:
24+
25+
```kotlin
26+
// settings.gradle.kts
27+
pluginManagement {
28+
repositories {
29+
gradlePluginPortal()
30+
maven("https://nexus.modlabs.cc/repository/maven-public/")
31+
mavenLocal()
32+
}
33+
}
34+
```
35+
2136
## Your first plugin
2237

2338
KTale plugin entrypoint is `ktale.api.KtalePlugin`:

docs/gradle-plugin.mdx

Lines changed: 17 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -10,6 +10,23 @@ KTale includes a Gradle plugin that writes dependency manifests into your jar so
1010

1111
## Usage (Gradle Kotlin DSL)
1212

13+
### Resolve the plugin
14+
15+
Add the ModLabs repo to `pluginManagement`:
16+
17+
```kotlin
18+
// settings.gradle.kts
19+
pluginManagement {
20+
repositories {
21+
gradlePluginPortal()
22+
maven("https://nexus.modlabs.cc/repository/maven-public/")
23+
mavenLocal()
24+
}
25+
}
26+
```
27+
28+
### Configure `ktaleDeps`
29+
1330
```kotlin
1431
plugins {
1532
id("cc.modlabs.ktale-deps")

docs/plugin-developer-workflow.mdx

Lines changed: 13 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -40,6 +40,19 @@ dependencies {
4040

4141
If you want a clean, unshaded jar and let the standalone host download deps:
4242

43+
#### Resolve the Gradle plugin
44+
45+
```kotlin
46+
// settings.gradle.kts
47+
pluginManagement {
48+
repositories {
49+
gradlePluginPortal()
50+
maven("https://nexus.modlabs.cc/repository/maven-public/")
51+
mavenLocal()
52+
}
53+
}
54+
```
55+
4356
```kotlin
4457
plugins {
4558
id("cc.modlabs.ktale-deps")

0 commit comments

Comments
 (0)