diff --git a/.github/workflows/test-readme-links.yml b/.github/workflows/test-readme-links.yml index 30cbb305..626a3017 100644 --- a/.github/workflows/test-readme-links.yml +++ b/.github/workflows/test-readme-links.yml @@ -1,4 +1,4 @@ -name: 'Check PR' +name: 'Test README links' on: push: diff --git a/README.md b/README.md index c70bee9f..5d0b55fb 100644 --- a/README.md +++ b/README.md @@ -32,8 +32,8 @@ api.getBuild(id = "hy5nxbzfjxe5k") ``` For configuring base URL and token via code and other available options, see the -[`Options` object][8]. HTTP caching is available, which can speed up queries significantly, but is -off by default. Enable with [`GRADLE_ENTERPRISE_API_CACHE_ENABLED`][12]. See [`Options.Cache`][13] +[`options` object][8]. HTTP caching is available, which can speed up queries significantly, but is +off by default. Enable with [`GRADLE_ENTERPRISE_API_CACHE_ENABLED`][12]. See [`CacheOptions`][13] for caveats.
@@ -120,13 +120,13 @@ API classes such as `GradleEnterpriseApi` and response models are generated from [5]: https://docs.gradle.com/enterprise/api-manual/#reference_documentation [6]: https://github.com/OpenAPITools/openapi-generator/blob/master/modules/openapi-generator-gradle-plugin/README.adoc [7]: https://gabrielfeo.github.io/gradle-enterprise-api-kotlin/ -[8]: https://gabrielfeo.github.io/gradle-enterprise-api-kotlin/gradle-enterprise-api-kotlin/com.gabrielfeo.gradle.enterprise.api/-options/ +[8]: https://gabrielfeo.github.io/gradle-enterprise-api-kotlin/gradle-enterprise-api-kotlin/com.gabrielfeo.gradle.enterprise.api/options.html [9]: https://gabrielfeo.github.io/gradle-enterprise-api-kotlin/gradle-enterprise-api-kotlin/com.gabrielfeo.gradle.enterprise.api/-gradle-enterprise-api/ [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 [11]: https://gabrielfeo.github.io/gradle-enterprise-api-kotlin/gradle-enterprise-api-kotlin/com.gabrielfeo.gradle.enterprise.api/shutdown.html -[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 -[13]: https://gabrielfeo.github.io/gradle-enterprise-api-kotlin/gradle-enterprise-api-kotlin/com.gabrielfeo.gradle.enterprise.api/-options/-cache/index.html +[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 +[13]: https://gabrielfeo.github.io/gradle-enterprise-api-kotlin/gradle-enterprise-api-kotlin/com.gabrielfeo.gradle.enterprise.api/-options/-cache-options/index.html [14]: https://jitpack.io/#gabrielfeo/gradle-enterprise-api-kotlin [15]: https://gabrielfeo.github.io/gradle-enterprise-api-kotlin/ [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 -[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 +[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 diff --git a/src/main/kotlin/com/gabrielfeo/gradle/enterprise/api/Options.kt b/src/main/kotlin/com/gabrielfeo/gradle/enterprise/api/Options.kt index f63785c0..2332287e 100644 --- a/src/main/kotlin/com/gabrielfeo/gradle/enterprise/api/Options.kt +++ b/src/main/kotlin/com/gabrielfeo/gradle/enterprise/api/Options.kt @@ -6,6 +6,9 @@ import com.gabrielfeo.gradle.enterprise.api.internal.* import java.io.File import kotlin.time.Duration.Companion.days +/** + * The global [Options] instance. + */ val options = Options(env = RealEnv, keychain = RealKeychain(RealEnv)) /**