Share via


Customize the upgrade plan when using GitHub Copilot App Modernization – upgrade for Java

This article describes how to customize the upgrade plan generated by GitHub Copilot App Modernization – upgrade for Java.

When you initiate an upgrade session, GitHub Copilot generates a plan.md file that outlines the steps and tasks required for the upgrade. This file serves as a blueprint for the upgrade process, which you can customize to better fit your project's needs. After the tool generates the plan.md file, it automatically opens in the Visual Studio Code editor. At this stage, you can review and customize the plan to ensure it aligns with your specific upgrade goals.

Example plan.md file structure

The following sections describe a sample plan.md file structure in order to illustrate the customization points.

Key customization areas

The following sections describe two key parameters in the plan that you can modify.

Build tool command option

This option is located under Project Information, and enables you to define custom command-line parameters for build tool execution. For valid options, see the Maven CLI or Gradle CLI documentation, depending on your project.

Examples:

  • For Maven: Build tool command options: -Dmaven.javadoc.skip=true -s "/path/to/custom/settings.xml"

  • For Gradle: Build tool command options: --info -Penv=production

Note

Replace the path with your actual settings file ___location as needed. This path shown is just an example.

Screenshot of Visual Studio Code that shows an example upgrade plan with upgrade targets highlighted.

Test validation

Located under the Additional Tasks section, you can enable or disable test execution by modifying the run tests before and after the upgrade flag.

  • Set to true to enable unit tests before and after upgrade.
  • Set to false to skip test validation.

This setting controls whether the tool runs unit tests to verify functional correctness during the upgrade.

By adjusting these settings, you can fine-tune the upgrade process to better suit your project's requirements.