Package io.quarkus.deployment.pkg

Interface PackageConfig

@ConfigMapping(prefix="quarkus.package") @ConfigRoot public interface PackageConfig
Packaging the application

Configuration relating to creating a packaged output.

  • Method Details

    • jar

      PackageConfig.JarConfig jar()
      Configuration which applies to building a JAR file for the project.

    • mainClass

      Optional<String> mainClass()
      The entry point of the application. This can either be a fully qualified name of a standard Java class with a main method, or QuarkusApplication.

      If your application has main classes annotated with QuarkusMain then this can also reference the name given in the annotation, to avoid the need to specify fully qualified names in the config.

    • outputDirectory

      Optional<Path> outputDirectory()
      The directory into which the output package(s) should be written. Relative paths are resolved from the build systems target directory.

    • outputName

      Optional<String> outputName()
      The name of the final artifact, excluding the suffix and file extension.

    • writeTransformedBytecodeToBuildOutput

      @WithDefault("false") boolean writeTransformedBytecodeToBuildOutput()
      Setting this switch to true will cause Quarkus to write the transformed application bytecode to the build tool's output directory. This is useful for post-build tools that need to scan the application bytecode (for example, offline code-coverage tools).

      For example, if using Maven, enabling this feature will result in the classes in target/classes being replaced with classes that have been transformed by Quarkus.

      Setting this to true, however, should be done with a lot of caution and only if subsequent builds are done in a clean environment (i.e. the build tool's output directory has been completely cleaned).

    • runnerSuffix

      @WithDefault("-runner") String runnerSuffix()
      The suffix that is applied to the runner artifact's base file name.

    • computedRunnerSuffix

      default String computedRunnerSuffix()
      Returns the runner suffix if addRunnerSuffix is true, or an empty string otherwise.
      Returns:
      the runner suffix if addRunnerSuffix is true, or an empty string otherwise