Index
All Classes and Interfaces|All Packages|Serialized Form
A
- artifact(Closure<?>) - Method in class io.github.intisy.gradle.github.extension.PublishExtension
-
Adds a single artifact entry, configured by the given Groovy closure.
- artifact(Action<? super ArtifactEntry>) - Method in class io.github.intisy.gradle.github.extension.PublishExtension
-
Adds a single artifact entry, configured by the given Gradle action.
- ArtifactEntry - Class in io.github.intisy.gradle.github.extension
-
A single JAR artifact to include in a GitHub release.
- ArtifactEntry() - Constructor for class io.github.intisy.gradle.github.extension.ArtifactEntry
- artifacts(Closure<?>) - Method in class io.github.intisy.gradle.github.extension.PublishExtension
-
Opens a Groovy-DSL configuration block for multiple artifact entries.
- artifacts(Action<? super PublishExtension>) - Method in class io.github.intisy.gradle.github.extension.PublishExtension
-
Opens a configuration block in which multiple
PublishExtension.artifact(org.gradle.api.Action<? super io.github.intisy.gradle.github.extension.ArtifactEntry>)calls can be made. - auth(Closure<?>) - Method in class io.github.intisy.gradle.github.extension.GithubExtension
-
Configures the nested auth extension using a Groovy closure.
- auth(Action<? super AuthExtension>) - Method in class io.github.intisy.gradle.github.extension.GithubExtension
-
Configures the nested auth extension using a Gradle action.
- AuthExtension - Class in io.github.intisy.gradle.github.extension
-
Extension for configuring GitHub authentication credentials.
- AuthExtension() - Constructor for class io.github.intisy.gradle.github.extension.AuthExtension
C
- cli(Closure<?>) - Method in class io.github.intisy.gradle.github.extension.GithubExtension
-
Configures the nested CLI extension using a Groovy closure.
- cli(Action<? super CliExtension>) - Method in class io.github.intisy.gradle.github.extension.GithubExtension
-
Configures the nested CLI extension using a Gradle action.
- CliExtension - Class in io.github.intisy.gradle.github.extension
-
Extension for configuring the local GitHub CLI (
gh) transport. - CliExtension() - Constructor for class io.github.intisy.gradle.github.extension.CliExtension
- cloneOrPullRepository(File) - Method in class io.github.intisy.gradle.github.impl.GitHub
-
Clones the configured resource repository if it doesn't exist, otherwise pulls the latest changes from the current branch.
- cloneOrPullRepository(File, String) - Method in class io.github.intisy.gradle.github.impl.GitHub
-
Clones the configured resource repository if it doesn't exist, otherwise pulls the latest changes.
- cloneOrPullRepository(File, String, String, String) - Method in class io.github.intisy.gradle.github.impl.GitHub
-
Clones a repository if it doesn't exist, otherwise pulls the latest changes.
- cloneRepository(File) - Method in class io.github.intisy.gradle.github.impl.GitHub
-
Clones the configured resource repository to the specified path.
- cloneRepository(File, String, String) - Method in class io.github.intisy.gradle.github.impl.GitHub
-
Clones a GitHub repository to the specified path.
- copyDirectory(Path, Path) - Static method in class io.github.intisy.gradle.github.utils.FileUtils
-
Copies a directory from the source path to the destination path.
- createRelease(String, String, String, String) - Method in class io.github.intisy.gradle.github.impl.GitHub
-
Creates a GitHub release for the given tag, reusing the existing release if the tag already exists.
D
- debug(String) - Method in class io.github.intisy.gradle.github.Logger
-
Logs a debug message.
- deleteDirectory(Path) - Static method in class io.github.intisy.gradle.github.utils.FileUtils
-
Deletes a directory and all its contents.
- doesRepoExist(File) - Method in class io.github.intisy.gradle.github.impl.GitHub
-
Checks if a Git repository exists at the specified path.
- downloadAsset(File, Object, String, String) - Method in class io.github.intisy.gradle.github.impl.GitHub
-
Deprecated.Use downloadAssetFromUrl instead
E
- error(String) - Method in class io.github.intisy.gradle.github.Logger
-
Logs an error message.
- error(String, Throwable) - Method in class io.github.intisy.gradle.github.Logger
-
Logs an error message along with an exception's stack trace.
F
- fetchReleaseByTag(String, String, String) - Method in class io.github.intisy.gradle.github.impl.GitHub
-
Attempts to fetch a GitHub release by tag, trying the given tag first and then a "v"-prefixed or "v"-stripped variant as a fallback.
- FileUtils - Class in io.github.intisy.gradle.github.utils
-
Author: Finn Birich
- FileUtils() - Constructor for class io.github.intisy.gradle.github.utils.FileUtils
G
- getAccessToken() - Method in class io.github.intisy.gradle.github.extension.GithubExtension
-
Deprecated.Prefer
GithubExtension.getAuth(). Retained so the plugin can honour the legacy field. - getAllModuleAssets(String, String, String, List<File>) - Method in class io.github.intisy.gradle.github.impl.GitHub
-
Downloads every module asset from a multi-module release (all assets named
repoName-<classifier>.jar, excluding-sources.jar/-javadoc.jar). - getAllProjectsRecursive(Project) - Static method in class io.github.intisy.gradle.github.utils.GradleUtils
-
Retrieves all projects recursively, starting from the specified project and including its subprojects, if any.
- getApiKey() - Method in class io.github.intisy.gradle.github.impl.GitHub
-
Gets the GitHub token used for REST calls and HTTPS git operations, resolving it from the
authextension (or the deprecatedaccessTokenfallback). - getArtifacts() - Method in class io.github.intisy.gradle.github.extension.PublishExtension
-
Returns the list of explicit artifacts to upload.
- getAsset(String) - Method in class io.github.intisy.gradle.github.impl.GitHub
-
Downloads and caches a release asset JAR file from the configured resource repository.
- getAsset(String, String, String) - Method in class io.github.intisy.gradle.github.impl.GitHub
-
Downloads and caches a release asset JAR file from a GitHub repository.
- getAssetWithClassifier(String, String, String, String) - Method in class io.github.intisy.gradle.github.impl.GitHub
-
Downloads and caches a classifier-specific JAR asset from a GitHub release.
- getAssetWithTransitives(String, String, String, Set<String>, List<File>) - Method in class io.github.intisy.gradle.github.impl.GitHub
-
Downloads a release asset JAR and recursively resolves its transitive GitHub dependencies.
- getAuth() - Method in class io.github.intisy.gradle.github.extension.GithubExtension
- getBranch() - Method in class io.github.intisy.gradle.github.extension.ResourcesExtension
- getClassifier() - Method in class io.github.intisy.gradle.github.extension.ArtifactEntry
- getCli() - Method in class io.github.intisy.gradle.github.extension.GithubExtension
- getCredentialsProvider(String) - Method in class io.github.intisy.gradle.github.impl.GitHub
-
Creates a credentials provider for Git operations.
- getGradleHome() - Static method in class io.github.intisy.gradle.github.utils.GradleUtils
-
Returns the path to the Gradle home directory.
- getJar() - Method in class io.github.intisy.gradle.github.extension.ArtifactEntry
- getJar() - Method in class io.github.intisy.gradle.github.extension.PublishExtension
- getLatestRelease() - Method in class io.github.intisy.gradle.github.impl.GitHub
-
Fetches the latest release from the configured resource repository.
- getLatestRelease(String, String) - Method in class io.github.intisy.gradle.github.impl.GitHub
-
Fetches the latest release from a GitHub repository.
- getLatestVersion() - Method in class io.github.intisy.gradle.github.impl.GitHub
-
Gets the latest version tag from the configured resource repository.
- getLatestVersion(String, String) - Method in class io.github.intisy.gradle.github.impl.GitHub
-
Gets the latest version tag from a GitHub repository.
- getOwner() - Method in class io.github.intisy.gradle.github.extension.PublishExtension
- getPath() - Method in class io.github.intisy.gradle.github.extension.ResourcesExtension
- getPublish() - Method in class io.github.intisy.gradle.github.extension.GithubExtension
- getReleaseName() - Method in class io.github.intisy.gradle.github.extension.PublishExtension
- getRemoteOwnerAndRepo(File) - Method in class io.github.intisy.gradle.github.impl.GitHub
-
Reads the git remote "origin" URL from the project directory and parses it into
[owner, repo]. - getRepo() - Method in class io.github.intisy.gradle.github.extension.PublishExtension
- getRepoUrl() - Method in class io.github.intisy.gradle.github.extension.ResourcesExtension
- getResilience() - Method in class io.github.intisy.gradle.github.extension.GithubExtension
- getResourceRepoName() - Method in class io.github.intisy.gradle.github.impl.GitHub
-
Extracts the repository name from the configured repository URL.
- getResourceRepoOwner() - Method in class io.github.intisy.gradle.github.impl.GitHub
-
Extracts the repository owner from the configured repository URL.
- getResources() - Method in class io.github.intisy.gradle.github.extension.GithubExtension
- getSshKey() - Method in class io.github.intisy.gradle.github.extension.AuthExtension
- getSshKey() - Method in class io.github.intisy.gradle.github.impl.GitHub
-
Gets the SSH private key contents used for git transport, resolving it from
auth.sshKey(or the deprecatedaccessTokenfallback when that holds an SSH key). - getTag() - Method in class io.github.intisy.gradle.github.extension.PublishExtension
- getToken() - Method in class io.github.intisy.gradle.github.extension.AuthExtension
- getTokenFile() - Method in class io.github.intisy.gradle.github.extension.AuthExtension
- getVersion() - Method in class io.github.intisy.gradle.github.extension.PublishExtension
- GitHub - Class in io.github.intisy.gradle.github.impl
-
GitHub helper class for managing GitHub repositories, releases, and assets.
- GitHub(Logger, ResourcesExtension, GithubExtension) - Constructor for class io.github.intisy.gradle.github.impl.GitHub
-
Constructs a new GitHub helper instance.
- GitHubCli - Class in io.github.intisy.gradle.github.impl
-
Routes GitHub REST calls through the local
ghCLI (gh api ...) instead of direct HTTP. - GitHubCli(Logger) - Constructor for class io.github.intisy.gradle.github.impl.GitHubCli
- GithubExtension - Class in io.github.intisy.gradle.github.extension
-
Extension for configuring GitHub integration.
- GithubExtension() - Constructor for class io.github.intisy.gradle.github.extension.GithubExtension
- Gradle - Class in io.github.intisy.gradle.github.impl
-
A helper class for interacting with Gradle.
- Gradle() - Constructor for class io.github.intisy.gradle.github.impl.Gradle
- GradleUtils - Class in io.github.intisy.gradle.github.utils
-
This utility class provides methods for interacting with Gradle.
- GradleUtils() - Constructor for class io.github.intisy.gradle.github.utils.GradleUtils
I
- io.github.intisy.gradle.github - package io.github.intisy.gradle.github
- io.github.intisy.gradle.github.extension - package io.github.intisy.gradle.github.extension
- io.github.intisy.gradle.github.impl - package io.github.intisy.gradle.github.impl
- io.github.intisy.gradle.github.utils - package io.github.intisy.gradle.github.utils
- isAvailable() - Method in class io.github.intisy.gradle.github.impl.GitHubCli
-
Checks whether the
ghCLI is installed and runnable. - isBuildOnly() - Method in class io.github.intisy.gradle.github.extension.ResourcesExtension
- isDebug() - Method in class io.github.intisy.gradle.github.extension.GithubExtension
- isEnabled() - Method in class io.github.intisy.gradle.github.extension.CliExtension
- isFallback() - Method in class io.github.intisy.gradle.github.extension.CliExtension
- isModules() - Method in class io.github.intisy.gradle.github.extension.ArtifactEntry
- isRepoUpToDate(File) - Method in class io.github.intisy.gradle.github.impl.GitHub
-
Checks if the local repository is up-to-date with the remote.
- isSkipOnRateLimit() - Method in class io.github.intisy.gradle.github.extension.GithubExtension
-
Deprecated.Replaced by the nested
resilience { skipOnRateLimit = ... }block. This delegates toResilienceExtension.isSkipOnRateLimit()and will be removed in a future release. - isSkipOnRateLimit() - Method in class io.github.intisy.gradle.github.extension.ResilienceExtension
- isUseCli() - Method in class io.github.intisy.gradle.github.extension.GithubExtension
-
Deprecated.Replaced by the nested
cli { enabled = ... }block. This delegates toCliExtension.isEnabled()and will be removed in a future release.
L
- log(String) - Method in class io.github.intisy.gradle.github.Logger
-
Logs a standard lifecycle message, visible in the default Gradle output.
- Logger - Class in io.github.intisy.gradle.github
-
A logger for the GitHub plugin.
- Logger(GithubExtension) - Constructor for class io.github.intisy.gradle.github.Logger
-
Creates a new logger.
- Logger(GithubExtension, Project) - Constructor for class io.github.intisy.gradle.github.Logger
-
Creates a new logger.
- Logger(Project) - Constructor for class io.github.intisy.gradle.github.Logger
-
Creates a new logger.
M
- modifyBuildFile(Project, String, String) - Static method in class io.github.intisy.gradle.github.impl.Gradle
-
Modifies the build file of a project.
P
- publish(Closure<?>) - Method in class io.github.intisy.gradle.github.extension.GithubExtension
-
Configures the nested publish extension using a Groovy closure.
- publish(Action<? super PublishExtension>) - Method in class io.github.intisy.gradle.github.extension.GithubExtension
-
Configures the nested publish extension using a Gradle action.
- PublishExtension - Class in io.github.intisy.gradle.github.extension
-
Extension for configuring the
publishGithubtask. - PublishExtension() - Constructor for class io.github.intisy.gradle.github.extension.PublishExtension
- pullRepository(File) - Method in class io.github.intisy.gradle.github.impl.GitHub
-
Pulls the latest changes from the current branch of the remote repository.
- pullRepository(File, String) - Method in class io.github.intisy.gradle.github.impl.GitHub
-
Pulls the latest changes from the remote repository.
R
- RateLimitException - Exception in io.github.intisy.gradle.github.impl
-
Thrown when a GitHub API request fails because the rate limit has been exceeded.
- RateLimitException(String) - Constructor for exception io.github.intisy.gradle.github.impl.RateLimitException
- readGithubDependencies(File) - Method in class io.github.intisy.gradle.github.impl.GitHub
-
Reads the embedded github-dependencies metadata from a JAR file.
- request(String, String, String) - Method in class io.github.intisy.gradle.github.impl.GitHubCli
-
Performs a GitHub REST request via
gh apiand adapts the result into an OkHttpResponse. - resilience(Closure<?>) - Method in class io.github.intisy.gradle.github.extension.GithubExtension
-
Configures the nested resilience extension using a Groovy closure.
- resilience(Action<? super ResilienceExtension>) - Method in class io.github.intisy.gradle.github.extension.GithubExtension
-
Configures the nested resilience extension using a Gradle action.
- ResilienceExtension - Class in io.github.intisy.gradle.github.extension
-
Extension for configuring how the plugin behaves when GitHub cannot be reached as expected.
- ResilienceExtension() - Constructor for class io.github.intisy.gradle.github.extension.ResilienceExtension
- resources(Closure<?>) - Method in class io.github.intisy.gradle.github.extension.GithubExtension
-
Configures the nested resources extension using a Groovy closure.
- resources(Action<? super ResourcesExtension>) - Method in class io.github.intisy.gradle.github.extension.GithubExtension
-
Configures the nested resources extension using a Gradle action.
- ResourcesExtension - Class in io.github.intisy.gradle.github.extension
-
Extension for configuring external resources to be used in the project.
- ResourcesExtension() - Constructor for class io.github.intisy.gradle.github.extension.ResourcesExtension
S
- safeSoftRefreshGradle(Project) - Static method in class io.github.intisy.gradle.github.impl.Gradle
-
Safely refreshes the Gradle project.
- selectJarAsset(JsonArray, String, String) - Method in class io.github.intisy.gradle.github.impl.GitHub
-
Selects the best JAR asset from a release using a prioritized matching strategy: (1) exact
repoName.jar, (2)repoName-version.jar, (3)repoName-standalone.jar, (4) first.jarnot ending in-sources.jaror-javadoc.jar. - setAccessToken(File) - Method in class io.github.intisy.gradle.github.extension.GithubExtension
-
Deprecated.Replaced by the nested
auth { }block (tokenFile/sshKey). Still honoured as a fallback and will be removed in a future release. - setAccessToken(String) - Method in class io.github.intisy.gradle.github.extension.GithubExtension
-
Deprecated.Replaced by the nested
auth { token = ... }block. Still honoured as a fallback and will be removed in a future release. - setAccessToken(Path) - Method in class io.github.intisy.gradle.github.extension.GithubExtension
-
Deprecated.Replaced by the nested
auth { }block (tokenFile/sshKey). Still honoured as a fallback and will be removed in a future release. - setBranch(String) - Method in class io.github.intisy.gradle.github.extension.ResourcesExtension
- setBuildOnly(boolean) - Method in class io.github.intisy.gradle.github.extension.ResourcesExtension
- setClassifier(String) - Method in class io.github.intisy.gradle.github.extension.ArtifactEntry
-
Sets the classifier that distinguishes this artifact from others in the same release.
- setDebug(boolean) - Method in class io.github.intisy.gradle.github.extension.GithubExtension
- setEnabled(boolean) - Method in class io.github.intisy.gradle.github.extension.CliExtension
-
Controls whether GitHub REST calls are routed through the local
ghCLI instead of direct HTTP. - setFallback(boolean) - Method in class io.github.intisy.gradle.github.extension.CliExtension
-
Controls whether the plugin falls back to direct HTTP when the
ghCLI is enabled but cannot be used (not installed, or a CLI invocation fails). - setJar(File) - Method in class io.github.intisy.gradle.github.extension.ArtifactEntry
-
Sets the JAR file to upload for this artifact.
- setJar(File) - Method in class io.github.intisy.gradle.github.extension.PublishExtension
-
Override the single JAR file to upload.
- setModules(boolean) - Method in class io.github.intisy.gradle.github.extension.ArtifactEntry
-
When true, this entry expands to one asset per subproject (
<repo>-<module>.jar) instead of uploadingArtifactEntry.getJar(); thejarandclassifierfields are then ignored. - setOwner(String) - Method in class io.github.intisy.gradle.github.extension.PublishExtension
-
Override the GitHub repository owner.
- setPath(String) - Method in class io.github.intisy.gradle.github.extension.ResourcesExtension
- setReleaseName(String) - Method in class io.github.intisy.gradle.github.extension.PublishExtension
-
Override the human-readable release title shown on GitHub.
- setRepo(String) - Method in class io.github.intisy.gradle.github.extension.PublishExtension
-
Override the GitHub repository name.
- setRepo(String) - Method in class io.github.intisy.gradle.github.extension.ResourcesExtension
-
Deprecated.Use
setRepoUrl(String)instead. - setRepoUrl(String) - Method in class io.github.intisy.gradle.github.extension.ResourcesExtension
- setSkipOnRateLimit(boolean) - Method in class io.github.intisy.gradle.github.extension.GithubExtension
-
Deprecated.Replaced by the nested
resilience { skipOnRateLimit = ... }block. This delegates toResilienceExtension.setSkipOnRateLimit(boolean)and will be removed in a future release. - setSkipOnRateLimit(boolean) - Method in class io.github.intisy.gradle.github.extension.ResilienceExtension
-
Controls how a GitHub API rate limit is handled.
- setSshKey(File) - Method in class io.github.intisy.gradle.github.extension.AuthExtension
-
Sets the SSH private key file used for git clone/pull over SSH.
- setSshKey(Path) - Method in class io.github.intisy.gradle.github.extension.AuthExtension
-
Sets the path to the SSH private key file used for git clone/pull over SSH.
- setTag(String) - Method in class io.github.intisy.gradle.github.extension.PublishExtension
-
Override the git tag pushed to GitHub for this release.
- setToken(String) - Method in class io.github.intisy.gradle.github.extension.AuthExtension
-
Sets an explicit GitHub token (Personal Access Token) used for REST calls and HTTPS git operations.
- setTokenFile(File) - Method in class io.github.intisy.gradle.github.extension.AuthExtension
-
Sets a file whose contents are a GitHub token.
- setTokenFile(Path) - Method in class io.github.intisy.gradle.github.extension.AuthExtension
-
Sets a path to a file whose contents are a GitHub token.
- setUseCli(boolean) - Method in class io.github.intisy.gradle.github.extension.GithubExtension
-
Deprecated.Replaced by the nested
cli { enabled = ... }block. This delegates toCliExtension.setEnabled(boolean)and will be removed in a future release. - setVersion(String) - Method in class io.github.intisy.gradle.github.extension.PublishExtension
-
Override the release version tag.
U
- uploadReleaseAsset(String, File, String) - Method in class io.github.intisy.gradle.github.impl.GitHub
-
Uploads a file as a release asset to GitHub.
W
- warn(String) - Method in class io.github.intisy.gradle.github.Logger
-
Logs a warning message.
All Classes and Interfaces|All Packages|Serialized Form