Index (agent-docs-publish-gradle-plugin 2.0.1 API)

A D E G H I P R S T V W
All Classes and Interfaces|All Packages

A

AgentDocsDistribution - Enum Class in io.github.duckasteroid.agentdocs.publish: Controls how a project's packaged agent docs are made discoverable to consumers.
AgentDocsPublishExtension - Class in io.github.duckasteroid.agentdocs.publish: Extension for configuring publish-side agent docs packaging.
AgentDocsPublishExtension() - Constructor for class io.github.duckasteroid.agentdocs.publish.AgentDocsPublishExtension
AgentDocsPublishPlugin - Class in io.github.duckasteroid.agentdocs.publish: Registers publish-side tasks that validate and package docs into an agent-docs sidecar zip.
AgentDocsPublishPlugin() - Constructor for class io.github.duckasteroid.agentdocs.publish.AgentDocsPublishPlugin
AgentDocsValidationRule - Interface in io.github.duckasteroid.agentdocs.publish.validation: Contract for a skill validation rule.
apply(Project) - Method in class io.github.duckasteroid.agentdocs.publish.AgentDocsPublishPlugin

D

declaredPluginIds() - Method in class io.github.duckasteroid.agentdocs.publish.validation.ValidationContext: Plugin ids declared via gradlePlugin { plugins { ... } } for this docs root, or empty when this context isn't the root of a multi-plugin-bundle layout.
details() - Method in record class io.github.duckasteroid.agentdocs.publish.validation.ValidationResult: Returns the value of the details record component.
docsDirectory() - Method in class io.github.duckasteroid.agentdocs.publish.validation.ValidationContext: Returns the configured docs directory.
DocsDirectoryExistsRule - Class in io.github.duckasteroid.agentdocs.publish.validation: Ensures the configured docs directory exists.
DocsDirectoryExistsRule() - Constructor for class io.github.duckasteroid.agentdocs.publish.validation.DocsDirectoryExistsRule

E

EMBEDDED - Enum constant in enum class io.github.duckasteroid.agentdocs.publish.AgentDocsDistribution: Copy the docs into the project's own jar (under a reserved resource path) and advertise them via an Agent-Docs: classpath manifest attribute.
equals(Object) - Method in record class io.github.duckasteroid.agentdocs.publish.validation.ValidationResult: Indicates whether some other object is "equal to" this one.
error(String, String) - Static method in record class io.github.duckasteroid.agentdocs.publish.validation.ValidationResult: Creates an error result.
ERROR - Enum constant in enum class io.github.duckasteroid.agentdocs.publish.validation.ValidationSeverity

G

getDeclaredPluginIds() - Method in class io.github.duckasteroid.agentdocs.publish.ValidateAgentDocsTask: Plugin ids declared via gradlePlugin { plugins { ... } } .
getDisabledValidationRules() - Method in class io.github.duckasteroid.agentdocs.publish.AgentDocsPublishExtension: Validation rule IDs to skip during validateAgentDocs.
getDisabledValidationRules() - Method in class io.github.duckasteroid.agentdocs.publish.ValidateAgentDocsTask: Rule IDs that should be skipped for this task run.
getDistribution() - Method in class io.github.duckasteroid.agentdocs.publish.AgentDocsPublishExtension: How packaged docs are made discoverable to consumers: embedded in the jar's own manifest/resources, or as a separate sidecar artifact.
getDocsDirectory() - Method in class io.github.duckasteroid.agentdocs.publish.AgentDocsPublishExtension: Directory containing the agent docs source tree to package.
getDocsDirectory() - Method in class io.github.duckasteroid.agentdocs.publish.ValidateAgentDocsTask: Docs directory containing the skill files to validate.
getOutputFile() - Method in class io.github.duckasteroid.agentdocs.publish.InstallAgentDocsSkillTask
getSkillContent() - Method in class io.github.duckasteroid.agentdocs.publish.InstallAgentDocsSkillTask
getSkillsDirectory() - Method in class io.github.duckasteroid.agentdocs.publish.AgentDocsPublishExtension: Root directory for generated skill files.

H

hashCode() - Method in record class io.github.duckasteroid.agentdocs.publish.validation.ValidationResult: Returns a hash code value for this object.

I

id() - Method in interface io.github.duckasteroid.agentdocs.publish.validation.AgentDocsValidationRule: Stable rule identifier used for opt-out configuration.
id() - Method in class io.github.duckasteroid.agentdocs.publish.validation.DocsDirectoryExistsRule
id() - Method in class io.github.duckasteroid.agentdocs.publish.validation.PluginBundleDirectoriesRule
id() - Method in class io.github.duckasteroid.agentdocs.publish.validation.SkillCompatibilityRule
id() - Method in class io.github.duckasteroid.agentdocs.publish.validation.SkillDescriptionRule
id() - Method in class io.github.duckasteroid.agentdocs.publish.validation.SkillEntrypointRule
id() - Method in class io.github.duckasteroid.agentdocs.publish.validation.SkillFrontmatterStructureRule
id() - Method in class io.github.duckasteroid.agentdocs.publish.validation.SkillNameRule
id() - Method in class io.github.duckasteroid.agentdocs.publish.validation.StandardDirectoriesRule
InstallAgentDocsSkillTask - Class in io.github.duckasteroid.agentdocs.publish: Writes the bundled agent-docs publish plugin usage guide (SKILL.md) into the consuming project's local agent skills folder so that local LLM agents can discover how to use the plugin.
InstallAgentDocsSkillTask() - Constructor for class io.github.duckasteroid.agentdocs.publish.InstallAgentDocsSkillTask
io.github.duckasteroid.agentdocs.publish - package io.github.duckasteroid.agentdocs.publish
io.github.duckasteroid.agentdocs.publish.validation - package io.github.duckasteroid.agentdocs.publish.validation

P

pass(String) - Static method in record class io.github.duckasteroid.agentdocs.publish.validation.ValidationResult: Creates a pass result with no severity.
PluginBundleDirectoriesRule - Class in io.github.duckasteroid.agentdocs.publish.validation: For java-gradle-plugin projects, ensures the docs root contains exactly one bundle subdirectory per declared plugin id and nothing else - no stray entries, and no top-level SKILL.md of its own.
PluginBundleDirectoriesRule() - Constructor for class io.github.duckasteroid.agentdocs.publish.validation.PluginBundleDirectoriesRule

R

rootEntries() - Method in class io.github.duckasteroid.agentdocs.publish.validation.ValidationContext: Lists docs root entries.
ruleId() - Method in record class io.github.duckasteroid.agentdocs.publish.validation.ValidationResult: Returns the value of the ruleId record component.

S

severity() - Method in record class io.github.duckasteroid.agentdocs.publish.validation.ValidationResult: Returns the value of the severity record component.
SIDECAR - Enum constant in enum class io.github.duckasteroid.agentdocs.publish.AgentDocsDistribution: Package the docs as a separate agent-docs classifier zip attached to Maven publications (the original mechanism), and advertise their existence via an Agent-Docs: maven manifest attribute on the main jar.
SkillCompatibilityRule - Class in io.github.duckasteroid.agentdocs.publish.validation: Validates optional compatibility frontmatter length.
SkillCompatibilityRule() - Constructor for class io.github.duckasteroid.agentdocs.publish.validation.SkillCompatibilityRule
SkillDescriptionRule - Class in io.github.duckasteroid.agentdocs.publish.validation: Validates required description frontmatter presence and length.
SkillDescriptionRule() - Constructor for class io.github.duckasteroid.agentdocs.publish.validation.SkillDescriptionRule
SkillEntrypointRule - Class in io.github.duckasteroid.agentdocs.publish.validation: Ensures exactly one SKILL.md exists at docs root.
SkillEntrypointRule() - Constructor for class io.github.duckasteroid.agentdocs.publish.validation.SkillEntrypointRule
SkillFrontmatterStructureRule - Class in io.github.duckasteroid.agentdocs.publish.validation: Ensures SKILL.md contains parseable YAML frontmatter.
SkillFrontmatterStructureRule() - Constructor for class io.github.duckasteroid.agentdocs.publish.validation.SkillFrontmatterStructureRule
SkillNameRule - Class in io.github.duckasteroid.agentdocs.publish.validation: Warns when publisher-provided name is present because resolver naming is authoritative.
SkillNameRule() - Constructor for class io.github.duckasteroid.agentdocs.publish.validation.SkillNameRule
StandardDirectoriesRule - Class in io.github.duckasteroid.agentdocs.publish.validation: Ensures standard optional skill directories are directories when present.
StandardDirectoriesRule() - Constructor for class io.github.duckasteroid.agentdocs.publish.validation.StandardDirectoriesRule

T

toString() - Method in record class io.github.duckasteroid.agentdocs.publish.validation.ValidationResult: Returns a string representation of this record class.

V

validate(ValidationContext) - Method in interface io.github.duckasteroid.agentdocs.publish.validation.AgentDocsValidationRule: Validates the docs using the provided context.
validate(ValidationContext) - Method in class io.github.duckasteroid.agentdocs.publish.validation.DocsDirectoryExistsRule
validate(ValidationContext) - Method in class io.github.duckasteroid.agentdocs.publish.validation.PluginBundleDirectoriesRule
validate(ValidationContext) - Method in class io.github.duckasteroid.agentdocs.publish.validation.SkillCompatibilityRule
validate(ValidationContext) - Method in class io.github.duckasteroid.agentdocs.publish.validation.SkillDescriptionRule
validate(ValidationContext) - Method in class io.github.duckasteroid.agentdocs.publish.validation.SkillEntrypointRule
validate(ValidationContext) - Method in class io.github.duckasteroid.agentdocs.publish.validation.SkillFrontmatterStructureRule
validate(ValidationContext) - Method in class io.github.duckasteroid.agentdocs.publish.validation.SkillNameRule
validate(ValidationContext) - Method in class io.github.duckasteroid.agentdocs.publish.validation.StandardDirectoriesRule
ValidateAgentDocsTask - Class in io.github.duckasteroid.agentdocs.publish: Validates docs by running a composite set of focused validation rules.
ValidateAgentDocsTask() - Constructor for class io.github.duckasteroid.agentdocs.publish.ValidateAgentDocsTask
ValidationContext - Class in io.github.duckasteroid.agentdocs.publish.validation: Shared state and file-system access helpers for validation rules.
ValidationContext(File) - Constructor for class io.github.duckasteroid.agentdocs.publish.validation.ValidationContext: Creates a validation context for a single-bundle docs directory (not a Gradle plugin project, or an individual plugin's own bundle directory within one).
ValidationContext(File, Set<String>) - Constructor for class io.github.duckasteroid.agentdocs.publish.validation.ValidationContext: Creates a validation context for the docs root of a java-gradle-plugin project, which must contain one bundle subdirectory per id in declaredPluginIds rather than a SKILL.md of its own.
ValidationResult - Record Class in io.github.duckasteroid.agentdocs.publish.validation: Result of evaluating a single validation rule.
ValidationResult(String, Optional<ValidationSeverity>, List<String>) - Constructor for record class io.github.duckasteroid.agentdocs.publish.validation.ValidationResult: Creates an instance of a ValidationResult record class.
ValidationSeverity - Enum Class in io.github.duckasteroid.agentdocs.publish.validation: Severity emitted by a validation rule.
valueOf(String) - Static method in enum class io.github.duckasteroid.agentdocs.publish.AgentDocsDistribution: Returns the enum constant of this class with the specified name.
valueOf(String) - Static method in enum class io.github.duckasteroid.agentdocs.publish.validation.ValidationSeverity: Returns the enum constant of this class with the specified name.
values() - Static method in enum class io.github.duckasteroid.agentdocs.publish.AgentDocsDistribution: Returns an array containing the constants of this enum class, in the order they are declared.
values() - Static method in enum class io.github.duckasteroid.agentdocs.publish.validation.ValidationSeverity: Returns an array containing the constants of this enum class, in the order they are declared.

W

warn(String, String) - Static method in record class io.github.duckasteroid.agentdocs.publish.validation.ValidationResult: Creates a warning result.
WARN - Enum constant in enum class io.github.duckasteroid.agentdocs.publish.validation.ValidationSeverity

A D E G H I P R S T V W
All Classes and Interfaces|All Packages