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

Class AuthSettings

java.lang.Object

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

public class AuthSettings
extends java.lang.Object

Configures GitHub authentication credentials.

 github {
     auth {
         token     = "ghp_..."                 // a Personal Access Token
         tokenFile = file("secrets/github.txt") // a file that contains a token
         sshKey    = file("~/.ssh/id_ed25519")  // an SSH private key for git clone/pull
     }
 }
 

The token (used for REST calls and HTTPS git operations) is resolved with the precedence token → tokenFile. The sshKey is independent and drives git transport over SSH. All fields are optional; when none are set the plugin operates unauthenticated (public repositories only).

Constructor Summary

Constructors

Constructor and Description
AuthSettings()

Method Summary

Modifier and Type	Method and Description
java.io.File	getSshKey()
java.lang.String	getToken()
java.io.File	getTokenFile()
void	setSshKey(java.io.File sshKey) Sets the SSH private key file used for git clone/pull over SSH.
void	setSshKey(java.nio.file.Path sshKey) Sets the path to the SSH private key file used for git clone/pull over SSH.
void	setToken(java.lang.String token) Sets an explicit GitHub token (Personal Access Token) used for REST calls and HTTPS git operations.
void	setTokenFile(java.io.File tokenFile) Sets a file whose contents are a GitHub token.
void	setTokenFile(java.nio.file.Path tokenFile) Sets a path to a file whose contents are a GitHub token.

Methods inherited from class java.lang.Object

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

Constructor Detail

AuthSettings

public AuthSettings()

Method Detail

setToken

public void setToken(java.lang.String token)

Sets an explicit GitHub token (Personal Access Token) used for REST calls and HTTPS git operations.

Parameters:

token - the token value.

getToken

public java.lang.String getToken()

Returns:

the explicit token, or null if none was set.

setTokenFile

public void setTokenFile(java.io.File tokenFile)

Sets a file whose contents are a GitHub token. Used when token is not set.

Parameters:

tokenFile - the file containing the token.

setTokenFile

public void setTokenFile(java.nio.file.Path tokenFile)

Sets a path to a file whose contents are a GitHub token.

Parameters:

tokenFile - the path to the file containing the token.

getTokenFile

public java.io.File getTokenFile()

Returns:

the token file, or null if none was set.

setSshKey

public void setSshKey(java.io.File sshKey)

Sets the SSH private key file used for git clone/pull over SSH.

Parameters:

sshKey - the private key file.

setSshKey

public void setSshKey(java.nio.file.Path sshKey)

Sets the path to the SSH private key file used for git clone/pull over SSH.

Parameters:

sshKey - the path to the private key file.

getSshKey

public java.io.File getSshKey()

Returns:

the SSH private key file, or null if none was set.