io.github.intisy.gradle.github.api.config

Interface GitHubConfig

All Known Implementing Classes:

GithubExtension

public interface GitHubConfig

Supplies the configuration GitHub needs, without requiring a Gradle build script.

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static class	GitHubConfig.Builder Assembles an immutable GitHubConfig by composing AuthSettings, CliSettings and ResilienceSettings, the same settings types the Gradle DSL configures.

Method Summary

Modifier and Type	Method and Description
static GitHubConfig.Builder	builder()
java.lang.String	getAccessToken()
AuthSettings	getAuth()
CliSettings	getCli()
ResilienceSettings	getResilience()

Method Detail

getAccessToken

java.lang.String getAccessToken()

Returns:

the deprecated single-value token or SSH key, or null if unset. Kept for backward compatibility; new configuration should use getAuth().

getAuth

AuthSettings getAuth()

Returns:

the structured token/SSH key configuration, preferred over getAccessToken().

getCli

CliSettings getCli()

Returns:

the settings controlling whether API calls are routed through the gh CLI.

getResilience

ResilienceSettings getResilience()

Returns:

the settings controlling fallback behavior when the GitHub API rate limit is hit.

builder

static GitHubConfig.Builder builder()

Returns:

a new GitHubConfig.Builder for assembling a GitHubConfig outside a Gradle build script. Every builder method is optional; GitHubConfig.Builder.build() with none called produces a config for fully anonymous, unauthenticated access.