Package io.github.intisy.gradle.github.extension

Class GithubExtension

java.lang.Object

io.github.intisy.gradle.github.extension.GithubExtension

public class GithubExtension
extends Object

Extension for configuring GitHub integration.

 github {
     accessToken = "ghp_..."   // or a file/path containing the token
     debug = true

     publish {
         owner   = "my-org"
         repo    = "my-repo"
         version = "2.0.0"
         jar     = file("build/libs/my-fat.jar")
     }

     resources {
         repoUrl = "https://github.com/my-org/my-resources"
         branch  = "main"
     }
 }
 

Constructor Summary

Constructors

Constructor	Description
GithubExtension()

Method Summary

Modifier and Type	Method	Description
String	getAccessToken()
PublishExtension	getPublish()
ResourcesExtension	getResources()
boolean	isDebug()
void	publish(groovy.lang.Closure<?> closure)	Configures the nested publish extension using a Groovy closure.
void	publish(org.gradle.api.Action<? super PublishExtension> action)	Configures the nested publish extension using a Gradle action.
void	resources(groovy.lang.Closure<?> closure)	Configures the nested resources extension using a Groovy closure.
void	resources(org.gradle.api.Action<? super ResourcesExtension> action)	Configures the nested resources extension using a Gradle action.
void	setAccessToken(File accessToken)
void	setAccessToken(String accessToken)
void	setAccessToken(Path accessToken)
void	setDebug(boolean debug)

Methods inherited from class java.lang.Object

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

Constructor Details

GithubExtension

public GithubExtension()

Method Details

setDebug

public void setDebug(boolean debug)

Parameters:

debug - Whether to enable debug logging.

isDebug

public boolean isDebug()

Returns:

Whether debug logging is enabled.

setAccessToken

public void setAccessToken(Path accessToken)

Parameters:

accessToken - The path to the access token.

setAccessToken

public void setAccessToken(File accessToken)

Parameters:

accessToken - The file containing the access token.

setAccessToken

public void setAccessToken(String accessToken)

Parameters:

accessToken - The access token string.

getAccessToken

public String getAccessToken()

Returns:

The access token.

getPublish

public PublishExtension getPublish()

Returns:

The nested publish extension.

publish

public void publish(org.gradle.api.Action<? super PublishExtension> action)

Configures the nested publish extension using a Gradle action.

Parameters:

action - The configuration action.

publish

public void publish(groovy.lang.Closure<?> closure)

Configures the nested publish extension using a Groovy closure. Supports Gradle Groovy DSL usage: publish { ... }

Parameters:

closure - The configuration closure.

getResources

public ResourcesExtension getResources()

Returns:

The nested resources extension.

resources

public void resources(org.gradle.api.Action<? super ResourcesExtension> action)

Configures the nested resources extension using a Gradle action.

Parameters:

action - The configuration action.

resources

public void resources(groovy.lang.Closure<?> closure)

Configures the nested resources extension using a Groovy closure. Supports Gradle Groovy DSL usage: resources { ... }

Parameters:

closure - The configuration closure.