Skip to content

Commit 76ec2a1

Browse files
author
Haixia Cheng
committed
add migration steps
1 parent acbbf3c commit 76ec2a1

File tree

4 files changed

+55
-0
lines changed

4 files changed

+55
-0
lines changed

jakarta-ee/student-web-app/README.md

Lines changed: 55 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -21,5 +21,60 @@ For how to start this project, see [getting started](doc/getting-started.md)
2121

2222
## Assess the Project
2323

24+
Please follow the steps below to assess and detect the Eclipse/Ant project:
25+
26+
1. Open [student-web-app](jakarta-ee/student-web-app) in VSCode.
27+
28+
1. Click **GitHub Copilot app modernization for Java** from the left side tool bar.
29+
30+
Click the `Toggle Chat` icon on the top, select `Agent` mode. If the **blue reload button** appears at the bottom, click it to reload the tools registration. This is only required the first time you install the extensions.
31+
32+
![assessment-start](assets/assessment-start.png)
33+
34+
1. Click **Run Assessment** button from the **Assessment** section on the left side view. It will open GitHub Copilot Chat window at the right side, and start to assess the project with the predefined prompt.
35+
36+
1. Interact with Copilot in the chat window and select **Continue** to proceed whenever you're ok with the actions suggested by the Copilot.
37+
38+
1. After the assessment is done, an **Assessment Report** will be generated and opened in the editor. From the bottom of the report, you can see **Build Tool (Ant)** in sectioin **Java Modernization**, and associated action **Migrate** to migrate the project to Maven project.
39+
40+
![assessment-ant-to-maven-solution](assets/assessment-ant-to-maven-solution.png)
41+
42+
## Convert Ant project to Maven project
43+
44+
Now you can convert the Ant project to Maven project.
45+
46+
1. Select Action **Migrate** associated with **Build Tool (Ant)**, and start the migration with the predefined prompt. Recommend to use LLM model **Claude Sonnet 3.7** for the migration.
47+
48+
![convert-ant-to-maven](assets/convert-ant-to-maven.png)
49+
50+
1. Interact with Copilot in the chat window and select **Continue** to proceed whenever you're ok with the actions suggested by the Copilot.
51+
52+
If you see the request from Copilot to ask you confirm the migration plan, please review and manually confirm the migration plan before proceeding. For example, input `Confirm` in the chat box and click `Send`.
53+
54+
1. After the migration is complete, select **Keep** for changed files.
55+
56+
## Assess and detect the legacy Java EE and Spring Framework project
57+
58+
Please follow the similar steps before to assess and detect the legacy Java EE and Spring Framework project:
59+
60+
1. Select **GitHub Copilot app modernization for Java** from the left side tool bar.
61+
1. Select **Run Assessment** from the **Assessment** section. It will open GitHub Copilot Chat window at the right side, and start to assess the project with the predefined prompt.
62+
1. Interact with Copilot in the chat window and select **Continue** to proceed whenever you're ok with the actions suggested by the Copilot.
63+
1. After the assessment is done, an **Assessment Report** will be generated and opened in the editor. From the bottom of the report, you can see **Framework Upgrade (Java EE/Jakarta EE)** and **Framework Upgrade (Spring Framework)** in sectioin **Java Modernization**, and associated action **Upgrade** to upgrade the project.
64+
65+
Before you proceed with the next step, manually clean up the assistant files of the assessment tool. They will be automatically cleaned up in the future releases of the tool.
66+
67+
1. Replace `appcat` with `*` in the `.github\appmod-java\.gitignore` file to ignore all files within the `.github\appmod-java` directory.
68+
1. Open **Source Control** view in VSCode, and select **Discard All Changes** to discard all changes made by the assessment tool.
69+
70+
## Upgrade the Project to Jakarta EE 10 and Spring Framework 6.x
71+
72+
Now you can upgrade the project. In this workshop, you select to upgrade Spring Framework version as it will also upgrade dependent Java EE version.
73+
74+
1. Select Action **Upgrade** associated with **Upgrade Spring Framework Version**, and start the upgrade with the predefined prompt. Recommend to use LLM model **Claude Sonnet 3.7** for the migration.
75+
1. Interact with Copilot in the chat window and select **Continue** to proceed whenever you're ok with the actions suggested by the Copilot.
76+
1. After the migration is complete, select **Keep** if there are any changed files.
77+
78+
There is an Upgrade Summary generated, review and do any follow-up actions based on your needs.
2479

2580

106 KB
Loading
121 KB
Loading
23.2 KB
Loading

0 commit comments

Comments
 (0)