Prerequisites
Review system, environment, and project requirements before starting a Java Modernization workflow with IBM Bob.
Review these requirements before initiating a Java Modernization workflow. A well-prepared project leads to faster, more accurate analysis and fewer interruptions during migration.
System requirements
| Requirement | Details |
|---|---|
| Java Development Kit (JDK) | JDK 8 minimum. Pre-installing the target JDK version (for example, JDK 21) is recommended. Bob can install target versions via SDKMan or WinGet. |
| IBM Bob | Version 2.0.0 or later, installed and authenticated. |
| Java Modernization package | Active license for the IBM Bob Premium Package for Java Modernization. |
| Git | Required if you are using Git flow features for branch and pull request management. |
SDKMan is required for managing Java version installations. Bob checks for SDKMan during the workflow and may prompt you to install it if not detected.
To initialize SDKMan in your shell, ensure it is sourced in your shell profile (~/.bashrc or ~/.zshrc). Restart your terminal session after installation.
WinGet (Windows Package Manager) is required for Java installation management.
After installing WinGet, restart IBM Bob and any open terminal sessions so that Bob can detect it on the updated PATH.
Project requirements
Build configuration
Your project must meet these requirements before starting any workflow:
- Valid Maven (
pom.xml) or Gradle (build.gradle) build configuration present. - Project opened at the correct root level in your IDE.
- Source code in a standard directory structure (
src/main/java,src/test/java). - All dependencies resolved and the project compiling successfully.
- Single-module projects: Open the folder containing your main
pom.xmlorbuild.gradle. - Multi-module projects: Open the parent project root. Ensure all modules are listed in the parent POM and inter-module dependencies are properly configured.
- Multiple-project workspaces: Select the correct project root when prompted by Bob.
Version control
Initialize Git with a clean working directory. Commit or stash any uncommitted changes before starting.
Create a dedicated migration branch:
git checkout -b java-modernizationEnvironment setup
Before starting a workflow, ensure your environment is ready:
- Build tool (Maven or Gradle) installed and configured.
- Terminal access available for running builds and tests.
- Network access available for dependency downloads.
- Unnecessary files and editors closed.
- Build artifacts cleared (optional but recommended).
.bobignore configuration
Configure .bobignore to protect sensitive files and exclude noise from Bob's analysis. The file uses .gitignore format and is located at .bob/.bobignore.
Exclude:
- Large dependencies and build artifacts
- Test data files
- Sensitive configuration files
Workflow-specific requirements
Backup and safety
Before starting any workflow:
Create a recent backup of your project files and ensure your Git repository is clean with all changes committed. Notify your team that modernization work is in progress.