Skip to content

Commit b453b63

Browse files
committed
Add instructions for using snapshot builds
1 parent 8c9eac2 commit b453b63

1 file changed

Lines changed: 33 additions & 0 deletions

File tree

README.md

Lines changed: 33 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -27,6 +27,39 @@ is required.
2727
> **Note:** The plugin is disabled by default in production to prevent exposing timing data that could
2828
> facilitate [timing attacks](https://w3c.github.io/server-timing/#security-considerations).
2929
30+
### Using Snapshot Builds
31+
32+
Snapshot builds are published to Maven Central Snapshots on every push to `main` and release branches. To use a snapshot
33+
version, add the Maven Central Snapshots repository to your `settings.gradle`:
34+
35+
```groovy
36+
dependencyResolutionManagement {
37+
repositories {
38+
mavenCentral()
39+
maven {
40+
url = 'https://central.sonatype.com/repository/maven-snapshots/'
41+
mavenContent {
42+
snapshotsOnly()
43+
}
44+
content {
45+
includeModule('org.grails.plugins', 'grails-server-timing')
46+
}
47+
}
48+
}
49+
}
50+
```
51+
52+
Then reference the snapshot version in your `build.gradle`:
53+
54+
```groovy
55+
dependencies {
56+
implementation 'org.grails.plugins:grails-server-timing:0.0.1-SNAPSHOT'
57+
}
58+
```
59+
60+
> **Note:** Snapshot versions are unstable and may change without notice. They are intended for testing
61+
> upcoming changes before a release.
62+
3063
## How It Works
3164

3265
The plugin intercepts HTTP requests using a servlet filter and a Grails interceptor:

0 commit comments

Comments
 (0)