GradleUp/shadow
Shadow
Shadow es un plugin de Gradle utilizado para crear fat JARs empaquetando una aplicación JVM y todas sus dependencias de tiempo de ejecución en un único archivo ejecutable. Funciona como un empaquetador de dependencias y generador de archivos, simplificando la distribución al fusionar múltiples archivos de biblioteca en un solo artefacto.
El proyecto se distingue por su capacidad para realizar reubicación de paquetes de bytecode, lo que renombra las rutas de los paquetes y las sentencias de importación para evitar conflictos de versiones en el classpath. También proporciona herramientas de fusión de recursos que combinan archivos con rutas idénticas utilizando transformadores personalizados de texto o XML, y produce builds reproducibles normalizando las marcas de tiempo y los permisos de los archivos.
El plugin cubre amplias capacidades, incluyendo el filtrado de contenido de archivos, gestión de manifiestos y la generación de scripts de inicio para el despliegue. También maneja la publicación de artefactos mediante flujos de trabajo basados en metadatos y proporciona utilidades de diagnóstico para la detección de entradas duplicadas y la localización de recursos en el classpath.
Features
- Fat JAR Plugins - Bundles an application and all its runtime dependencies into a single executable fat JAR.
- Package Relocation - Provides bytecode-level package relocation to avoid classpath conflicts between different library versions.
- Shadowed Artifact Publishing - Uploads fat archives to repositories and generates metadata files with correct dependency scopes.
- Project Bundling - Merges project configurations and dependencies into a single self-contained executable file.
- JVM Application Bundling - Packages combined archives with startup scripts and configuration files into compressed folders ready for production environments.
- Fat JAR Flattening - Extracts all runtime dependencies into a single flat executable archive for simplified distribution.
- JVM Dependency Bundlers - Merges JVM application sources and runtime dependencies into a single executable archive.
- Cross-Project Dependency Merging - Combines dependencies from multiple projects in a single build into one unified archive output.
- Resource File Merging - Combines resource files with identical paths from different dependencies using custom transformers.
- Artifact Metadata Publishing - Publishes target versions and bundling attributes as metadata so downstream consumers resolve dependencies correctly.
- Dependency Scope Configurations - Specifies which runtime dependencies are bundled into the final archive and which remain as external declarations.
- Startup Script Generation - Creates executable scripts to launch the application with custom output directories and environment variables.
- Dependency Exclusions - Explicitly excludes specific direct dependencies from the final merged archive to reduce file size.
- Shadowed Artifact Exposure - Configures project elements to serve the combined archive instead of the standard one to dependent projects.
- Deployment Archive Bundling - Bundles combined archives with startup scripts and supporting files into compressed folders for distribution.
- Archive Content Filtering - Uses pattern-matching rules to selectively include or exclude files and dependencies from the final archive.
- Library Artifact Bundling - Combines multiple library files into a single artifact to simplify the publishing process and reduce consumer dependencies.
- Manifest Execution Configuration - Configures the application entry point and classpath via metadata within the archive manifest.
- Archive Manifest Customization - Merges entries from multiple sources and inherits standard attributes to define executable properties in the manifest.
- External Dependency Manifesting - Keeps runtime dependencies outside the archive while automatically listing them in the manifest path.
- Duplicate Entry Resolution - Provides strategies to handle file collisions during merging, such as keeping, ignoring, or failing the build.
- Reproducible Builds - Ensures identical binary output across different environments by normalizing file timestamps and permissions.
- Reproducible Archiving - Ensures byte-for-byte identical archives by normalizing file timestamps and permissions.
- Resource Transformers - Implements custom text and XML transformers to merge resource files with identical paths from multiple dependencies.
- Resource Deduplication - Combines files sharing the same path by appending content or removing duplicate entries to minimize size.
