Skip to content

Commit

Permalink
README: New section for Gradle snapshot instructions
Browse files Browse the repository at this point in the history
  • Loading branch information
bitspittle committed Feb 13, 2024
1 parent 6217380 commit 1d0a457
Showing 1 changed file with 19 additions and 0 deletions.
19 changes: 19 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -130,6 +130,25 @@ kotlin {
> binaries. For example, [here is Kotter's CI workflow](https://github.com/varabyte/kotter/blob/main/.github/workflows/publish.yml)
> which runs on both Linux and Mac targets to build platform-specific Kotter artifacts.
#### Testing snapshots

Most users won't ever need to run a Kotter snapshot, so feel free to skip over this section! However, occasionally, bug
fixes and new features will be available for testing for a short period before they are released.

If you ever file a bug with Kotter and are asked to test a fix using a snapshot, you must add an entry for the sonatype
snapshots repository to your `repositories` block in order to allow Gradle to find it:

```kotlin
// build.gradle.kts

repositories {
mavenCentral()
// ↓↓↓↓↓↓↓↓↓↓↓↓↓↓↓↓↓↓↓↓↓↓↓↓↓↓↓↓↓↓↓↓↓↓↓↓↓↓↓↓↓↓↓↓↓↓↓↓↓↓↓↓↓↓↓↓↓↓↓↓↓↓↓↓↓↓
maven("https://s01.oss.sonatype.org/content/repositories/snapshots/")
// ↑↑↑↑↑↑↑↑↑↑↑↑↑↑↑↑↑↑↑↑↑↑↑↑↑↑↑↑↑↑↑↑↑↑↑↑↑↑↑↑↑↑↑↑↑↑↑↑↑↑↑↑↑↑↑↑↑↑↑↑↑↑↑↑↑↑
}
```

### 🚥 Running examples

If you've cloned this repository, examples are located under the [examples](examples) folder.
Expand Down

0 comments on commit 1d0a457

Please sign in to comment.