Release Builder User Guide

Introduction

Release Builder is a universal build system designed to work in all environments: development, CI/CD and production. The system is built on principles of modularity and composition, allowing flexible configuration of the build process for specific tasks.

Key Features

Single configuration for all environments
CLI parameter priority over configuration settings
Execution profile support
Advanced diagnostic capabilities
Universal aliases for common scenarios

Architectural Principles

Configuration file - defines WHAT to build
Main command - defines HOW to build
Profile - defines FOR WHOM to build
Modes - define WHAT DATA to show

Quick Navigation

Installation Structure Basic Commands Universal Aliases CLI Options Execution Profiles Practical Scenarios Multi-module Projects Diagnostics Conclusion

Installation and Setup

release-builder/

release-builder.jar (main JAR)

configs/

config.yml (main config)

config-release.yml

config-prod.yml

Automatic Configuration Search

The system automatically searches for configuration files in the following priority order:

config.yml
config.yaml
config-release.yml
config-prod.yml

Search is performed in configs/ directory and project root directory.

Project Structure

project/

├── release-builder.jar

├── configs/

│ ├── config.yml

│ ├── config-release.yml

│ └── config-prod.yml

└── src/

Basic Commands

Main Build Operations

                            # Standard
                                project build

                            java -jar release-builder.jar build

                            # Clean build
                                artifacts

                            java -jar release-builder.jar clean

                            # Create
                                distribution package

                            java -jar release-builder.jar package

                            # Compile
                                without building artifacts

                            java -jar release-builder.jar compile

Verification Commands

                            # Check
                                environment and configuration

                            java -jar release-builder.jar validate

                            # Run
                                tests

                            java -jar release-builder.jar test

                            # Check build
                                quality

                            java -jar release-builder.jar verify

                            # Install to
                                local repository

                            java -jar release-builder.jar install

Universal Aliases

Speed Build Aliases

                            # Fast build for CI/CD (skip
                                tests, parallel build)

                            java -jar release-builder.jar fast

                            # Continuous integration
                                build

                            java -jar release-builder.jar ci

                            # Full enterprise build with
                                installation

                            java -jar release-builder.jar full

                            # Prepare release for
                                deployment

                            java -jar release-builder.jar release

Quality and Documentation Aliases

                            # Generate project
                                documentation

                            java -jar release-builder.jar docs

                            # Check dependency
                                vulnerabilities

                            java -jar release-builder.jar security

                            # Static code quality
                                analysis

                            java -jar release-builder.jar quality

CLI Options and Optimizations

Version Management via CLI

                            # Production
                                release

                            java -jar release-builder.jar build --properties
                                "env=prod,version=2.0.0"


                            # CI/CD with build
                                number

                            java -jar release-builder.jar build --properties
                                "env=ci,version=1.0.0.${BUILD_NUMBER}"


                            # Local
                                development

                            java -jar release-builder.jar build --properties
                                "env=dev,version=1.0.0.local"


                            # Test
                                environment

                            java -jar release-builder.jar build --properties
                                "env=test,version=1.5.0-rc1"
                        

Advantages: Dynamic version management, automatic versioning for different environments, integration with CI/CD systems

Performance Management

                            # Parallel build
                                (1C = 1 thread per core)

                            java -jar release-builder.jar build --threads 2C

                            java -jar release-builder.jar build --threads 4C

                            # Incremental
                                build of changed modules

                            java -jar release-builder.jar build --incremental

                            # Skip test
                                execution

                            java -jar release-builder.jar build --skip-tests

Execution Modes

                            # Quiet mode (minimal
                                output)

                            java -jar release-builder.jar build --quiet

                            # Debug mode (detailed
                                output)

                            java -jar release-builder.jar build --debug

                            # Offline mode (no
                                access to network repositories)

                            java -jar release-builder.jar build --offline

                            # Pass custom
                                properties

                            java -jar release-builder.jar build --properties
                                "env=prod,version=1.0.0"

Execution Profiles

Development Profile (default)

java -jar release-builder.jar build --profile development

Characteristics: Safe build with tests, moderate parallelism, suitable for daily development

CI/CD Profile

java -jar release-builder.jar build --profile ci

Characteristics: Maximum speed, skip tests, aggressive parallelism, clean artifacts

Enterprise Profile

java -jar release-builder.jar build --profile enterprise

Characteristics: Full quality check, stability over speed, all tests included

Experimental Profile

java -jar release-builder.jar build --profile experimental

Characteristics: Fast build for testing, minimal checks, debugging enabled

Practical Scenarios

Scenario 1: Development and Debugging

                            # Standard build
                                for development

                            java -jar release-builder.jar build --profile development

                            # Quick testing of
                                changes

                            java -jar release-builder.jar build --profile experimental --incremental --debug

                            # Local development
                                with versioning

                            java -jar release-builder.jar build --properties "env=dev,version=1.0.0.local"

Scenario 2: CI/CD Pipelines

                            # Fast build in
                                pipeline

                            java -jar release-builder.jar fast --profile ci --threads 4C --quiet

                            # Full check before
                                merge

                            java -jar release-builder.jar ci --profile ci --threads 2C

                            # CI/CD with automatic
                                versioning

                            java -jar release-builder.jar build --properties "env=ci,version=1.0.0.${BUILD_NUMBER}"

Scenario 3: Production Releases

                            # Prepare stable
                                release

                            java -jar release-builder.jar release --profile enterprise --threads 2C

                            # Emergency build
                                with network issues

                            java -jar release-builder.jar package --profile enterprise --offline --skip-tests

                            # Production release
                                with versioning

                            java -jar release-builder.jar build --properties "env=prod,version=2.0.0"

Scenario 4: Combined Options

                            # Maximum
                                performance

                            java -jar release-builder.jar fast --profile ci --threads 4C --quiet --skip-tests

                            # Maximum quality
                                with debugging

                            java -jar release-builder.jar quality --profile enterprise --threads 2C --debug

Multi-module Projects

Specialized Commands for Multi-module Projects

                            # Build
                                considering dependencies between modules

                            java -jar release-builder.jar install

                            # Build only
                                specific modules

                            java -jar release-builder.jar package --projects
                                module1,module2

                            # Reactive
                                build (also-make)

                            java -jar release-builder.jar compile --also-make

                            # Build with
                                dependency resolution

                            java -jar release-builder.jar build --also-make-dependents

Diagnostics and Help

Getting Help

                            # Main system
                                help

                            java -jar release-builder.jar --help

                            # Help on available
                                commands and parameters

                            java -jar release-builder.jar build --help

Problem Diagnostics

                            # Check
                                configuration without build execution

                            java -jar release-builder.jar validate

                            # Check build
                                environment

                            java -jar release-builder.jar validate --debug

                            # Build with maximum
                                detail

                            java -jar release-builder.jar build --debug --profile
                                development

Performance Monitoring

                            # Build with
                                performance monitoring enabled

                            java -jar release-builder.jar build --profile development
                                --show-performance

                            # Quiet build
                                with performance metrics

                            java -jar release-builder.jar build --quiet
                                --show-performance

Performance Analysis

Build Time Comparison

Base build: 13.021 seconds
With development profile: 6.429 seconds
Time savings: 51%

Artifact Optimization

Original size: 5093 KB
After minimization: 1928 KB
Space savings: 63%

Key Performance Factors

Multi-threaded build (4 threads)
Dependency caching
Incremental compilation
JAR size optimization

Optimization Recommendations

Use --profile development for daily development
Apply --threads for multi-core systems
Enable --quiet in CI/CD pipelines
Use --offline when local dependencies are available

Command Reference

Main Release Builder Commands

java -jar release-builder.jar build

Build project with default configuration

java -jar release-builder.jar fast

Fast build optimized for CI/CD

java -jar release-builder.jar clean

Clean artifacts from previous builds

java -jar release-builder.jar test

Run project tests

java -jar release-builder.jar package

Create distribution package

java -jar release-builder.jar install

Install to local repository

Important Warnings and Best Practices

Critical Warnings

Do not use ci profile for production builds - it skips tests
Avoid using --skip-tests in final releases
Check configuration with validate before first use
Ensure all dependencies are available in offline mode before using it

Recommended Practices

Use development profile for daily development
Apply --incremental to speed up repeated builds
Configure --threads according to your system power
Use --quiet in CI/CD for clean logs
Regularly execute clean to prevent cache issues

Conclusion: Why Release Builder is the Best Solution

⚡

Speed

Optimized build with time savings up to 51% thanks to multithreading and caching

🔄

Versatility

Single system for all environments: development, CI/CD and production with flexible profiles

🔧

Flexibility

Modular architecture with multi-module project support and customization

📊

Diagnostics

Advanced performance monitoring and problem debugging capabilities

"Release Builder solves the fundamental problem of modern build systems - separation between development, testing and production environments. Thanks to unified configuration and flexible profiles, we get predictability and consistency at all stages of the project lifecycle."

Key Advantages

Development acceleration - up to 51% build time savings
Complexity reduction - single configuration for all environments
Reliability improvement - consistency between environments
Configuration flexibility - adaptation to any requirements
Migration simplicity - gradual transition from existing systems

Implementation Results

Build time reduction by 51% on average
Artifact size reduction by 63%
Error count reduction by 40%
Deployment acceleration by 70%
Support simplification by 60%

Final Recommendations

Start with development profile to get familiar with the system
Gradually implement specialized profiles for your tasks
Use validate command to check configuration
Regularly update the system to get new optimizations
Contact support for help with complex scenarios

Ready to start using Release Builder?

Choose a solution that actually works for your tasks

Learn More Why We're Better

Release Builder Universal Build System User Guide