craft_parts.plugins.gradle_use_plugin module

The gradle-use plugin.

class craft_parts.plugins.gradle_use_plugin.GradleUsePlugin(*, properties, part_info)

Bases: GradlePlugin

A plugin to publish Gradle artifacts to a local Maven repository.

This plugin uses the common plugin keywords as well as those for “sources”. For more information check the ‘plugins’ topic for the former and the ‘sources’ topic for the latter.

Additionally, this plugin uses the following plugin-specific keywords:

  • gradle-init-script: (string) Path to the Gradle init script to use during build task execution.

  • gradle-parameters: (list of strings) Flags to pass to the build using the gradle semantics for parameters.

  • gradle-use-daemon: (boolean, default False) Whether to use the Gradle daemon during the build.

Parameters:
get_build_commands()

Return a list of commands to run during the build step.

Return type:

list[str]

properties_class

alias of GradleUsePluginProperties

class craft_parts.plugins.gradle_use_plugin.GradleUsePluginProperties(**data)

Bases: PluginProperties

The part properties used by the gradle plugin.

  • gradle_init_script: (string) The path to init script to run before build script is executed.

  • gradle_parameters: (list of strings) Extra arguments to pass along to Gradle task execution.

  • gradle_use_daemon: (boolean) Whether to use the Gradle daemon during the build.

Parameters:

data (Any)

gradle_init_script: str
gradle_parameters: list[str]
gradle_use_daemon: bool
model_config: ClassVar[ConfigDict] = {'alias_generator': <function PluginProperties.<lambda>>, 'extra': 'forbid', 'frozen': True, 'validate_assignment': True}

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

plugin: Literal['gradle-use']
source: str