craft_parts.utils.maven package

Submodules

• craft_parts.utils.maven.common module
  • MavenArtifact
    • MavenArtifact.artifact_id
    • MavenArtifact.field_name
    • MavenArtifact.from_element()
    • MavenArtifact.from_pom()
    • MavenArtifact.group_id
    • MavenArtifact.packaging_type
    • MavenArtifact.update_versions()
    • MavenArtifact.version
  • MavenParent
    • MavenParent.field_name
  • MavenPlugin
    • MavenPlugin.field_name
    • MavenPlugin.from_element()
    • MavenPlugin.update_versions()
  • MavenXMLError
    • MavenXMLError.details
    • MavenXMLError.message
  • create_maven_settings()
  • update_pom()

Module contents

Common Maven utilities.

craft_parts.utils.maven.create_maven_settings(*, part_info, set_mirror)

Create a Maven configuration file.

The settings file contains additional configuration for Maven, such as proxy parameters and a reference to the backstage repository.

Parameters:

• part_info (PartInfo) – The part info for the part invoking Maven.

• set_mirror (bool) – Whether to configure for a local build.

Return type:

Path

Returns:

Returns a Path object to the newly created settings file.

craft_parts.utils.maven.update_pom(*, part_info, deploy_to, self_contained, pom_file=None)

Update the POM file of a Maven project.

Parameters:

• part_info (PartInfo) – Information about the invoking part.

• deploy_to (Path | None) – The path to configure the mvn deploy location. If None, no path is configured.

• self_contained (bool) – Whether or not to patch version numbers with what is actually available.

• pom_file (Path | None) – The optional Maven POM file to update. If None, the function will try to use pom.xml on the part’s build subdir.

Return type:

None