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

Class ResilienceSettings

java.lang.Object

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

public class ResilienceSettings
extends java.lang.Object

Configures how the plugin behaves when GitHub cannot be reached as expected.

 github {
     resilience {
         skipOnRateLimit = true
     }
 }
 

Constructor Summary

Constructors

Constructor and Description
ResilienceSettings()

Method Summary

Modifier and Type	Method and Description
boolean	isSkipOnRateLimit()
void	setSkipOnRateLimit(boolean skipOnRateLimit) Controls how a GitHub API rate limit is handled.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

ResilienceSettings

public ResilienceSettings()

Method Detail

setSkipOnRateLimit

public void setSkipOnRateLimit(boolean skipOnRateLimit)

Controls how a GitHub API rate limit is handled. When enabled, the plugin degrades gracefully instead of failing the build: a rate-limited dependency resolution falls back to the cached (possibly outdated) jar when one exists, and an update check keeps the currently declared version. Only when no cached copy exists is the dependency skipped. Defaults to false, which aborts the build on a rate limit.

Parameters:

skipOnRateLimit - whether to degrade gracefully (rather than fail) when the rate limit is hit.

isSkipOnRateLimit

public boolean isSkipOnRateLimit()

Returns:

whether rate-limited operations degrade gracefully instead of failing the build.