A B C D E F G H I J K L M N O P Q R S T U V W X Y Z _

A

addCoreExtension(java.lang.String, Class<T>, org.gradle.api.Project, java.lang.Object) - Method in CoreExtension
Creates an extension on the core extension
addStaticFilesAsDocumentProvider(org.gradle.api.Project, Provider<File>, java.lang.String, org.ysb33r.ysf.projects.core.documentation.DocumentationType, Action<DocumentationEntity>) - Method in InternalDocumentsUtils
Adds a source of documentation which is fixed and not provided by a task.
addTaskAsDocumentProvider(org.gradle.api.Project, Provider<File>, TaskProvider<?>, org.ysb33r.ysf.projects.core.documentation.DocumentationType, Action<DocumentationEntity>) - Method in InternalDocumentsUtils
Adds a source of documentation.
AntoraGitlabTagManipulator - Class in org.ysb33r.ysf.projects.core.internal.gitlab
Utility to work with Antora Gitlab tags.
AntoraGitlabTagManipulator(org.ysb33r.ysf.projects.core.internal.gitlab.GitlabProjectClient, boolean) - Constructor in AntoraGitlabTagManipulator
API_DOCS_CONFIGURATION - Field in CorePlugin
API_DOCS_NAVIGATION_METADATA_SUBDIR - Field in DocumentationCoreExtension
API_DOCS_NAVIGATION_METADATA_SUBDIR - Field in InternalDocumentsUtils
API_DOCS_PREPARE_TASK - Field in CorePlugin
apply(org.gradle.api.Project) - Method in CorePlugin
apply(org.gradle.api.Project) - Method in JvmCorePlugin
ASCIIDOC - Enum Constant in DocumentationType
Asciidoc files.
AsciidocSourceExtension - Class in org.ysb33r.ysf.projects.core.extensions
Adds Asciidoc attributes to the project.
AsciidocSourceExtension(org.gradle.api.Project) - Constructor in AsciidocSourceExtension
ASSEMBLE_DOCS_LIFECYCLE_TASK - Field in CorePlugin
attributes(Map<String, ?>) - Method in AsciidocSourceExtension
Adds project attributes

B

BUILT_API_DOCS_HTML - Enum Constant in DocumentationType
Content is HTML that has been created by another task.

C

client - Property in AntoraGitlabTagManipulator
CODENARC_ALL_TASK - Field in JvmCorePlugin
CODENARC_CONFIGURATION - Field in JvmCorePlugin
CODENARC_PREFIX - Field in JvmCorePlugin
CODENARC_VERSION_PROPERTY - Field in JvmCorePlugin
configure(org.gradle.api.Project) - Method in JReleaserUtils
configureJavaGoogleFormat(org.gradle.api.Project) - Method in JvmCorePlugin
copyResourceToFile(java.lang.String, java.io.File) - Method in ProjectUtils
CoreExtension - Class in org.ysb33r.ysf.projects.core.extensions
Project extension to use for all YSF project
CoreExtension(org.gradle.api.Project) - Constructor in CoreExtension
CorePlugin - Class in org.ysb33r.ysf.projects.core.plugins
The core plugin which is applied by all plugins in this plugin suite.
CorePlugin() - Constructor in CorePlugin
create(java.lang.String) - Method in GitlabProjectClient
Creates a client to talk to Gitlab
createTag(java.lang.String, java.lang.String) - Method in AntoraGitlabTagManipulator
Creates a tag in Gitlab.

D

DEFAULT_LICENSE_TYPE - Field in CoreExtension
DefaultDocumentationEntity - Class in org.ysb33r.ysf.projects.core.internal.documentation
Working class for defining internal documentation
DefaultDocumentationEntity(org.gradle.api.Project, java.lang.String, org.ysb33r.ysf.projects.core.documentation.DocumentationType) - Constructor in DefaultDocumentationEntity
deleteTagIfExists(java.lang.String) - Method in AntoraGitlabTagManipulator
DOCUMENTATION_TASK_GROUP - Field in CorePlugin
DocumentationCoreExtension - Class in org.ysb33r.ysf.projects.core.extensions
For registering files and outputs of a project as documentation
DocumentationCoreExtension(org.gradle.api.Project) - Constructor in DocumentationCoreExtension
DocumentationEntity - Interface in org.ysb33r.ysf.projects.core.documentation
Describes properties project documentation documentation.
DocumentationType - Enum in org.ysb33r.ysf.projects.core.documentation
Documentation type
documents(Provider<File>, org.ysb33r.ysf.projects.core.documentation.DocumentationType, java.lang.String, Action<DocumentationEntity>) - Method in DocumentationCoreExtension
Adds the fixed documents at the provided location to the internal document collection.

E

email - Property in Person
execute(org.jreleaser.gradle.plugin.dsl.release.BaseReleaser$Issues) - Method in JReleaserUtils.1
execute(org.jreleaser.gradle.plugin.dsl.project.Project) - Method in JReleaserUtils.2
exposeJavaPackagesInDocs(java.lang.String) - Method in JvmCoreExtension
Add packages which should be exposed in GroovyDoc.

F

findCoreExtension(org.gradle.api.Project, Class<T>) - Method in CoreExtension
Finds an extension on the core extension
findExtension(org.gradle.api.Project) - Method in CoreExtension
Find this extension.

G

getAntoraLinkType() - Method in DocumentationType
getAntoraType() - Method in DocumentationType
Type of Antora documentation
getArtifactDescription() - Method in JvmCoreExtension
Description of the main artifact produced by this project.
getAttributes() - Method in AsciidocSourceExtension
Gets the project-wide document attributes.
getAttributesProvider() - Method in AsciidocSourceExtension
A provider of attributes.
getContributors() - Method in CoreExtension
A list of contributors to the project from gradle/developers.yml.
getDocsRootUri() - Method in GitlabCoreExtension
The URL where documentation for this project will be found.
getEntryPoint() - Method in DefaultDocumentationEntity
The entrypoint for the specific documentation
getGitlabApiAuthToken() - Method in GitlabCoreExtension
Obtains the Gitlab API token.
getGitlabApiAuthUser() - Method in GitlabCoreExtension
The user that is interacting with Gitlab.
getGitlabBranch() - Method in GitlabCoreExtension
The Gitlab commit branch.
getGitlabToken() - Method in GitlabClient
Token for connecting to Gitlab API.
getGitlabUri() - Method in GitlabCoreExtension
Get the project URI.
getHttpClient() - Method in GitlabClient
The client for connecting to Gitlab.
getIssueUrl() - Method in GitlabCoreExtension
The URL of the issues page for the project.
getJavaPackagesInDocs() - Method in JvmCoreExtension
List of packages for which links can be created in docs.
getLicenseType() - Method in CoreExtension
The project license type.
getMaintainers() - Method in CoreExtension
A list of project maintainers from gradle/developers.yml.
getNavsEntryRelativePath() - Method in DefaultDocumentationEntity
Get navigation relative path for placing a description of the Navigation entry
getPrivatePath() - Method in DefaultDocumentationEntity
A subpath that distinguised these documents from all others
getProjectCurrentYear() - Method in CoreExtension
The last year of the project.
getProjectIdentifier() - Method in GitlabClient
The Gitlab project identifier
getProjectInceptionYear() - Method in CoreExtension
Returns the first year of the project.
getProjectYearRange() - Method in CoreExtension
A formatted string showing the project years.
getPublishAssets() - Method in GitlabCoreExtension
Whether assets should be published to Gitlab.
getRelativePath() - Method in DefaultDocumentationEntity
Get relative path for placing documentation.
getReleaseAnnouncementTemplate() - Method in ProjectDetailsExtension
Returns a template which can be used for announcement message.
getSection() - Method in DefaultDocumentationEntity
Name of section.
getTags() - Method in ProjectDetailsExtension
Project tags that can be used for announcements.
getTitle() - Method in DefaultDocumentationEntity
Reads the title of the documentation
GITLAB_PAGES - Field in GitlabCoreExtension
GITLAB_SERVER - Field in GitlabProjectClient
GITLAB_SERVER_OVERRIDE_PROPERTY - Field in GitlabProjectClient
Primarily used for testing to override the URL
GitlabClient - Interface in org.ysb33r.ysf.projects.core.internal.gitlab
Describes the interface for a Gitlab client.
GitlabCoreExtension - Class in org.ysb33r.ysf.projects.core.extensions
Gitlab core configuration
GitlabCoreExtension(org.gradle.api.Project) - Constructor in GitlabCoreExtension
GitlabProjectClient - Class in org.ysb33r.ysf.projects.core.internal.gitlab
Holds an HTTP client, the project identifier and the Gitlab token
GitlabProjectClient(org.ysb33r.ysf.projects.core.internal.gitlab.GitlabProjectClient, java.lang.String) - Constructor in GitlabProjectClient
gitlabToken - Property in GitlabProjectClient

H

httpClient - Property in GitlabProjectClient

I

id - Property in Person
IDE_REPORT_NAME - Field in JvmCorePlugin
INCOMING_API_DOCUMENTATION - Field in CorePlugin
INCOMING_API_DOCUMENTATION_RESOLVED - Field in CorePlugin
incomingDocumentCopySpec(Provider<String>) - Method in DocumentationCoreExtension
Provides a copy specification for incoming documents.
InternalDocumentsUtils - Class in org.ysb33r.ysf.projects.core.internal.documentation
` Common methods for declaring and configuring internal documents.
InternalDocumentsUtils() - Constructor in InternalDocumentsUtils

J

javaLanguageVersion(java.lang.String) - Method in JvmCoreExtension
Set the language toolchain to use.
JReleaserUtils - Class in org.ysb33r.ysf.projects.core.internal.jreleaser
Configures JReleaser.
JReleaserUtils.1 - Class in org.ysb33r.ysf.projects.core.internal.jreleaser
JReleaserUtils.1() - Constructor in JReleaserUtils.1
JReleaserUtils.2 - Class in org.ysb33r.ysf.projects.core.internal.jreleaser
JReleaserUtils.2() - Constructor in JReleaserUtils.2
JReleaserUtils() - Constructor in JReleaserUtils
JvmCoreExtension - Class in org.ysb33r.ysf.projects.core.extensions
An extension for configuring JVM-based development.
JvmCoreExtension(org.gradle.api.Project) - Constructor in JvmCoreExtension
JvmCorePlugin - Class in org.ysb33r.ysf.projects.core.plugins
Core plugin for JVM projects.
JvmCorePlugin() - Constructor in JvmCorePlugin

K

L

loadPropertiesFromResource(java.lang.String) - Method in ProjectUtils
loadTextFromResource(java.lang.String) - Method in ProjectUtils

M

multiProject - Property in CoreExtension
Indicates that this project is part of a multi-project build.

N

NAME - Field in AsciidocSourceExtension
NAME - Field in CoreExtension
NAME - Field in DocumentationCoreExtension
NAME - Field in GitlabCoreExtension
NAME - Field in JvmCoreExtension
name - Property in Person
NAME - Field in ProjectDetailsExtension

O

P

Person - Class in org.ysb33r.ysf.projects.core
Defines project contributors
Person() - Constructor in Person
PREPROCESSED_DOCS_SUBDIR - Field in CorePlugin
PREPROCESSED_SOURCES_SUBDIR - Field in CorePlugin
ProjectDetailsExtension - Class in org.ysb33r.ysf.projects.core.extensions
An extension which describes some core details w.r.t. the project.
ProjectDetailsExtension(org.gradle.api.Project) - Constructor in ProjectDetailsExtension
Defines the details of maintainers and contributors
projectIdentifier - Property in GitlabCoreExtension
The numeric identifier of the project.
projectIdentifier - Property in GitlabProjectClient
projectsWithDocuments(Spec<String>) - Method in DocumentationCoreExtension
Aggregate document artifacts from some subprojects according to a filter
ProjectUtils - Class in org.ysb33r.ysf.projects.core.internal.documentation
Internal utilities.
ProjectUtils() - Constructor in ProjectUtils
PUBLISH_BINARY_LIFECYCLE_TASK - Field in CorePlugin
PUBLISH_DOCS_LIFECYCLE_TASK - Field in CorePlugin
PUBLISH_TASK_GROUP - Field in CorePlugin

Q

R

RAW_GROOVY_SOURCE - Enum Constant in DocumentationType
Raw Groovy (and Java) source code.
RESOURCES_PREFIX - Field in ProjectUtils
rootProject - Property in CoreExtension
Indicates that the current project is the root project.

S

setArtifactDescription(java.lang.Object) - Method in JvmCoreExtension
Sets a description for the artifact.
setDiscordChannel(java.lang.String) - Method in AsciidocSourceExtension
Sets the name for the Discord channel.
setDocsRootUri(java.lang.Object) - Method in GitlabCoreExtension
Set the documentation uri.
setEntryPoint(Provider<String>) - Method in DefaultDocumentationEntity
Sets the entrypoint in a lazy way.
setEntryPoint(Provider<String>) - Method in DocumentationEntity
Sets the entrypoint in a lazy way.
setGitlabUri(java.lang.Object) - Method in GitlabCoreExtension
Set the project uri.
setLicenseType(java.lang.Object) - Method in CoreExtension
Set a SPDX license type.
setProjectCurrentYear(java.lang.Object) - Method in CoreExtension
Sets the current copyright year of the project.
setProjectInceptionYear(java.lang.Object) - Method in CoreExtension
Sets the project inception year.
setPublishAssets(boolean) - Method in GitlabCoreExtension
setReleaseAnnouncementTemplate(java.lang.Object) - Method in ProjectDetailsExtension
Set the announcement template.
setSection(java.lang.String) - Method in DefaultDocumentationEntity
Set a different section for the documentation set.
setSection(java.lang.String) - Method in DocumentationEntity
Set a different section for the documentation set.
setSnapshotCheckProvider(Provider<Boolean>) - Method in CoreExtension
Allow a change to the provider of determines whether the project version is a SNAPSHOT.
setTitleProvider(Provider<String>) - Method in DefaultDocumentationEntity
Sets the method that will provide a title for the specific set of internal documentation.
setTitleProvider(Provider<String>) - Method in DocumentationEntity
Sets the method that will provide a title for the specific set of internal documentation.
SKIP_TEST_TASKS_PROPERTY - Field in JvmCorePlugin
snapshot() - Method in CoreExtension
A provider for determining whether the project version is a SNAPSHOT.
SPOTLESS_PLUGIN_ID - Field in JvmCorePlugin
stackTraceWithDeleteFailure - Property in AntoraGitlabTagManipulator
standardHeaders(java.lang.String) - Method in AntoraGitlabTagManipulator
SUBPATH_DEVELOPERS - Field in CoreExtension

T

tags(java.lang.String) - Method in ProjectDetailsExtension
One of more tags that can be added to announcements
tagsHostPath(java.lang.String) - Method in AntoraGitlabTagManipulator
Gitlab path to tags API.
type - Property in DefaultDocumentationEntity

U

V

VERSION_PROPERTIES - Field in JvmCorePlugin
versionOf(java.lang.String, java.lang.String) - Method in CoreExtension
Finds a version in the version catalog.

W

withGradleDocAttributes(java.lang.String) - Method in AsciidocSourceExtension
Adds Gradle linkage attributes but use a specific gradleVersion.

X

Y

YSF_BASE_URL - Field in GitlabCoreExtension

Z

_

A B C D E F G H I J K L M N O P Q R S T U V W X Y Z _