Skip to content

Commit 3b62324

Browse files
authored
Fix README links (#16)
Broken after #14
1 parent 3ca525e commit 3b62324

File tree

3 files changed

+10
-7
lines changed

3 files changed

+10
-7
lines changed

.github/workflows/test-readme-links.yml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
name: 'Check PR'
1+
name: 'Test README links'
22

33
on:
44
push:

README.md

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -32,8 +32,8 @@ api.getBuild(id = "hy5nxbzfjxe5k")
3232
```
3333

3434
For configuring base URL and token via code and other available options, see the
35-
[`Options` object][8]. HTTP caching is available, which can speed up queries significantly, but is
36-
off by default. Enable with [`GRADLE_ENTERPRISE_API_CACHE_ENABLED`][12]. See [`Options.Cache`][13]
35+
[`options` object][8]. HTTP caching is available, which can speed up queries significantly, but is
36+
off by default. Enable with [`GRADLE_ENTERPRISE_API_CACHE_ENABLED`][12]. See [`CacheOptions`][13]
3737
for caveats.
3838

3939
<details>
@@ -120,13 +120,13 @@ API classes such as `GradleEnterpriseApi` and response models are generated from
120120
[5]: https://docs.gradle.com/enterprise/api-manual/#reference_documentation
121121
[6]: https://github.com/OpenAPITools/openapi-generator/blob/master/modules/openapi-generator-gradle-plugin/README.adoc
122122
[7]: https://gabrielfeo.github.io/gradle-enterprise-api-kotlin/
123-
[8]: https://gabrielfeo.github.io/gradle-enterprise-api-kotlin/gradle-enterprise-api-kotlin/com.gabrielfeo.gradle.enterprise.api/-options/
123+
[8]: https://gabrielfeo.github.io/gradle-enterprise-api-kotlin/gradle-enterprise-api-kotlin/com.gabrielfeo.gradle.enterprise.api/options.html
124124
[9]: https://gabrielfeo.github.io/gradle-enterprise-api-kotlin/gradle-enterprise-api-kotlin/com.gabrielfeo.gradle.enterprise.api/-gradle-enterprise-api/
125125
[10]: https://gabrielfeo.github.io/gradle-enterprise-api-kotlin/gradle-enterprise-api-kotlin/com.gabrielfeo.gradle.enterprise.api/-gradle-enterprise-api/index.html#373241164%2FExtensions%2F769193423
126126
[11]: https://gabrielfeo.github.io/gradle-enterprise-api-kotlin/gradle-enterprise-api-kotlin/com.gabrielfeo.gradle.enterprise.api/shutdown.html
127-
[12]: https://gabrielfeo.github.io/gradle-enterprise-api-kotlin/gradle-enterprise-api-kotlin/com.gabrielfeo.gradle.enterprise.api/-options/-cache/index.html#-1054137809%2FProperties%2F769193423
128-
[13]: https://gabrielfeo.github.io/gradle-enterprise-api-kotlin/gradle-enterprise-api-kotlin/com.gabrielfeo.gradle.enterprise.api/-options/-cache/index.html
127+
[12]: https://gabrielfeo.github.io/gradle-enterprise-api-kotlin/gradle-enterprise-api-kotlin/com.gabrielfeo.gradle.enterprise.api/-options/-cache-options/index.html#1054652077%2FProperties%2F769193423
128+
[13]: https://gabrielfeo.github.io/gradle-enterprise-api-kotlin/gradle-enterprise-api-kotlin/com.gabrielfeo.gradle.enterprise.api/-options/-cache-options/index.html
129129
[14]: https://jitpack.io/#gabrielfeo/gradle-enterprise-api-kotlin
130130
[15]: https://gabrielfeo.github.io/gradle-enterprise-api-kotlin/
131131
[16]: https://gabrielfeo.github.io/gradle-enterprise-api-kotlin/gradle-enterprise-api-kotlin/com.gabrielfeo.gradle.enterprise.api/-options/-gradle-enterprise-instance-options/index.html#-259580834%2FProperties%2F769193423
132-
[17]: https://gabrielfeo.github.io/gradle-enterprise-api-kotlin/gradle-enterprise-api-kotlin/com.gabrielfeo.gradle.enterprise.api/-options/-gradle-enterprise-instance/index.html#2124126004%2FProperties%2F769193423
132+
[17]: https://gabrielfeo.github.io/gradle-enterprise-api-kotlin/gradle-enterprise-api-kotlin/com.gabrielfeo.gradle.enterprise.api/-options/-gradle-enterprise-instance-options/index.html#-42243308%2FProperties%2F769193423

src/main/kotlin/com/gabrielfeo/gradle/enterprise/api/Options.kt

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -6,6 +6,9 @@ import com.gabrielfeo.gradle.enterprise.api.internal.*
66
import java.io.File
77
import kotlin.time.Duration.Companion.days
88

9+
/**
10+
* The global [Options] instance.
11+
*/
912
val options = Options(env = RealEnv, keychain = RealKeychain(RealEnv))
1013

1114
/**

0 commit comments

Comments
 (0)