EmbedCodeExtension

Configures Embed Code for a Gradle project.

The extension maps directly to Embed Code command-line options and does not create or require a YAML configuration file.

Constructors

constructor()

abstract val codePath: DirectoryProperty

The root directory containing source files used by embedding instructions.

abstract val docExcludes: ListProperty<String>

Glob patterns selecting documentation files to skip.

abstract val docIncludes: ListProperty<String>

Glob patterns selecting documentation files to process.

abstract val docsPath: DirectoryProperty

The root directory containing Markdown or HTML documentation.

abstract val downloadBaseUrl: Property<String>

The base URL of the Embed Code releases.

abstract val githubToken: Property<String>

An optional GitHub token used to read release checksum metadata.

abstract val info: Property<Boolean>

Whether Embed Code should print informational log messages.

abstract val separator: Property<String>

Text inserted between joined fragment parts.

abstract val sha256: Property<String>

An optional SHA-256 digest of the configured release asset.

abstract val stacktrace: Property<Boolean>

Whether Embed Code should print stack traces after panics.

abstract val version: Property<String>

The exact Embed Code release tag to install.

fun namedSource(name: String, directory: Directory)

Adds a named source root.

fun namedSource(name: String, directory: Provider<Directory>)

Adds a named source root supplied by another Gradle provider.