Skip to content

Commit a5d2c00

Browse files
brunoborgesCopilot
brunoborges
and
Copilot
committed
Split README into project info + workshop steps
- README.md: Keep project overview, architecture, and run locally sections - WORKSHOP.md: Extract App Modernization content as a single-page reference - workshop/: Split into 6 step files (overview, prerequisites, assess, upgrade, health endpoints, containerize) - docs/: Update GitHub Pages site to reflect new workshop structure Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
1 parent fcee5b6 commit a5d2c00

10 files changed

Lines changed: 454 additions & 105 deletions

File tree

‎README.md‎

Lines changed: 10 additions & 91 deletions
Original file line numberDiff line numberDiff line change
@@ -10,12 +10,7 @@ The modernization will transform your application from the outdated technologies
1010
- [Overview](#overview)
1111
- [Current Architecture](#current-architecture)
1212
- [Run Locally](#run-locally)
13-
- [App Modernization](#app-modernization)
14-
- [Install GitHub Copilot app modernization](#install-github-copilot-app-modernization)
15-
- [Assess Your Java Application](#assess-your-java-application)
16-
- [Upgrade Runtime & Frameworks](#upgrade-runtime--frameworks)
17-
- [Expose health endpoints using Custom Tasks](#expose-health-endpoints-using-custom-tasks)
18-
- [Containerize Applications](#containerize-applications)
13+
- [App Modernization Workshop](#app-modernization-workshop)
1914

2015
## Overview
2116

@@ -135,93 +130,17 @@ scripts/startapp.sh
135130

136131
To stop, run `stopapp.cmd` or `stopapp.sh` in the `scripts` directory.
137132

138-
## App Modernization
133+
## App Modernization Workshop
139134

140-
The following sections guide you through the process of modernizing the sample Java application `asset-manager` to Azure using GitHub Copilot app modernization.
135+
Ready to modernize this application? Follow the step-by-step workshop guide:
141136

142-
**Prerequisites**:
143-
- A GitHub account with [GitHub Copilot](https://github.com/features/copilot) enabled. A Pro, Pro+, Business, or Enterprise plan is required.
144-
- One of the following IDEs:
145-
- The latest version of [Visual Studio Code](https://code.visualstudio.com/). Must be version 1.101 or later.
146-
- [GitHub Copilot in Visual Studio Code](https://code.visualstudio.com/docs/copilot/overview). For setup instructions, see [Set up GitHub Copilot in Visual Studio Code](https://code.visualstudio.com/docs/copilot/setup). Be sure to sign in to your GitHub account within Visual Studio Code.
147-
- [GitHub Copilot app modernization](https://marketplace.visualstudio.com/items?itemName=vscjava.migrate-java-to-azure). Restart Visual Studio Code after installation.
148-
- The latest version of [IntelliJ IDEA](https://www.jetbrains.com/idea/download). Must be version 2023.3 or later.
149-
- [GitHub Copilot](https://plugins.jetbrains.com/plugin/17718-github-copilot). Must be version 1.5.59 or later. For more instructions, see [Set up GitHub Copilot in IntelliJ IDEA](https://docs.github.com/en/copilot/get-started/quickstart). Be sure to sign in to your GitHub account within IntelliJ IDEA.
150-
- [GitHub Copilot app modernization](https://plugins.jetbrains.com/plugin/28791-github-copilot-app-modernization). Restart IntelliJ IDEA after installation. If you don't have GitHub Copilot installed, you can install GitHub Copilot app modernization directly.
151-
- For more efficient use of Copilot in app modernization: in the IntelliJ IDEA settings, select the **Tools** > **GitHub Copilot** configuration window, and then select **Auto-approve** and **Trust MCP Tool Annotations**. For more information, see [Configure settings for GitHub Copilot app modernization to optimize the experience for IntelliJ](configure-settings-intellij.md).
152-
- [Java JDK](/java/openjdk/download) for both the source and target JDK versions.
153-
- [Maven](https://maven.apache.org/download.cgi) or [Gradle](https://gradle.org/install/) to build Java projects.
154-
- A Git-managed Java project using Maven or Gradle.
155-
- For Maven-based projects: access to the public Maven Central repository.
156-
- In the Visual Studio Code settings, make sure `chat.extensionTools.enabled` is set to `true`. This setting might be controlled by your organization.
157-
158-
> Note: If you're using Gradle, only the Gradle wrapper version 5+ is supported. The Kotlin Domain Specific Language (DSL) isn't supported.
159-
>
160-
> The function `My Tasks` isn't supported yet for IntelliJ IDEA.
161-
162-
### Install GitHub Copilot app modernization
163-
164-
In VSCode, open the Extensions view from the Activity Bar, search for the `GitHub Copilot app modernization` extension in the marketplace. Click the Install button for the extension. After installation completes, you should see a notification in the bottom-right corner of VSCode confirming success.
165-
166-
**Alternative: IntelliJ IDEA**
167-
Alternatively, you can use IntelliJ IDEA. Open **File** > **Settings** (or **IntelliJ IDEA** > **Preferences** on macOS), navigate to **Plugins** > **Marketplace**, search for `GitHub Copilot app modernization`, and click **Install**. Restart IntelliJ IDEA if prompted.
168-
169-
### Assess Your Java Application
170-
171-
The first step is to assess the sample Java application `asset-manager`. The assessment provides insights into the application's readiness for migration to Azure.
172-
173-
1. Open VS Code with all the prerequisites installed for the asset manager by changing the directory to the `asset-manager` directory and running `code .` in that directory.
174-
1. Open the `GitHub Copilot app modernization` extension.
175-
1. In the **QUICKSTART** view, click the **Migrate to Azure** button to trigger app assessment.
176-
177-
![Trigger Assessment](doc-media/trigger-assessment.png)
178-
179-
1. Wait for the assessment to be completed and the report to be generated.
180-
1. Review the **Assessment Report**. Select the **Issues** tab to view the proposed solutions for the issues identified in the report.
181-
182-
### Upgrade Runtime & Frameworks
183-
184-
1. In the **Java Upgrade** table at the bottom of the **Issues** tab, click the **Run Task** button of the first entry **Java Version Upgrade**.
185-
186-
![Java Upgrade](doc-media/java-upgrade.png)
187-
1. After clicking the **Run Task** button, the Copilot Chat panel will open with Agent Mode. The agent will check out a new branch and start upgrading the JDK version and Spring/Spring Boot framework. Click **Allow** for any requests from the agent.
188-
189-
> Note: The upgrading tool also supports upgrading to JDK 25 (the latest LTS version). To do this, click on the generated chat message, edit the target Java version to 25, and then click **Send** to apply the change.
190-
191-
### Expose health endpoints using Custom Tasks
192-
193-
In this section, you will use custom tasks to expose health endpoints for your applications instead of writing code yourself. The following steps demonstrate how to generate custom tasks based on external web links and proper prompts.
194-
195-
> Note: Custom tasks are not supported for the IntelliJ IDEA plugin. If you are using IntelliJ IDEA, you can skip this section.
196-
197-
1. Open the sidebar of `GITHUB COPILOT APP MODERNIZATION`. Click the `+` button in the **Tasks** view to create a custom task.
198-
199-
![Create Formula From Source Control](doc-media/create-formula-from-source-control.png)
200-
1. In the opened tab, enter the **Task Name** and **Task Prompt** as shown below:
201-
- **Task Name**: Expose health endpoint via Spring Boot Actuator
202-
- **Task Prompt**: You are a Spring Boot developer assistant, follow the Spring Boot Actuator documentation to add basic health endpoints for Azure Container Apps deployment.
203-
1. Click the **Add References** button to add the Spring Boot Actuator official documentation as references.
204-
205-
![Health endpoint task](doc-media/health-endpoint-task.png)
206-
1. In the popped-up quick-pick window, select **External links**. Then paste the following link: `https://docs.spring.io/spring-boot/reference/actuator/endpoints.html`. Click **Save** to create the task.
207-
1. Click the **Run** button to trigger the custom task.
208-
1. Follow the same steps as the predefined task to review and apply the changes.
209-
1. Review the proposed code changes and click **Keep** to apply them.
210-
211-
### Containerize Applications
212-
213-
Now that you have completed the upgrade and health endpoint steps, the next step is to prepare your application for cloud deployment by containerizing both the web and worker modules. In this section, you will use **Containerization Tasks** to containerize your applications.
214-
215-
1. Open the sidebar of `GITHUB COPILOT APP MODERNIZATION`. In **Tasks** view, click the **Run Task** button of **Java** -> **Containerization Tasks** -> **Containerize Application**.
216-
217-
![Run Containerize Application task](doc-media/containerization-run-task.png)
218-
219-
1. A predefined prompt will be populated in the Copilot Chat panel with Agent Mode. Copilot Agent will start to analyze the workspace and to create a **containerization-plan.copiotmd** with the containerization plan.
220-
221-
![Containerization prompt and plan](doc-media/containerization-plan.png)
222-
1. View the plan and collaborate with Copilot Agent as it follows the **Execution Steps** in the plan by clicking **Continue**/**Allow** in pop-up chat notifications to run commands. Some of the execution steps leverage agentic tools of **Container Assist**.
137+
👉 **[Start the Workshop →](WORKSHOP.md)**
223138

224-
<!-- ![Containerization execution steps](doc-media/containerization-execution-steps.png) -->
225-
1. Copilot Agent will help generate Dockerfile, build Docker images and fix build errors if there are any. Click **Keep** to apply the generated code.
139+
The workshop covers:
140+
- Installing GitHub Copilot app modernization
141+
- Assessing your Java application
142+
- Upgrading runtime & frameworks (Java 8 → 21, Spring Boot 2.x → 3.x)
143+
- Exposing health endpoints using custom tasks
144+
- Containerizing applications
226145

227146

‎WORKSHOP.md‎

Lines changed: 105 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,105 @@
1+
# App Modernization Workshop
2+
3+
The following sections guide you through the process of modernizing the sample Java application `asset-manager` to Azure using GitHub Copilot app modernization.
4+
5+
## Table of Contents
6+
7+
- [Prerequisites](#prerequisites)
8+
- [Install GitHub Copilot app modernization](#install-github-copilot-app-modernization)
9+
- [Assess Your Java Application](#assess-your-java-application)
10+
- [Upgrade Runtime & Frameworks](#upgrade-runtime--frameworks)
11+
- [Expose health endpoints using Custom Tasks](#expose-health-endpoints-using-custom-tasks)
12+
- [Containerize Applications](#containerize-applications)
13+
14+
## Prerequisites
15+
16+
- A GitHub account with [GitHub Copilot](https://github.com/features/copilot) enabled. A Pro, Pro+, Business, or Enterprise plan is required.
17+
- One of the following IDEs:
18+
- The latest version of [Visual Studio Code](https://code.visualstudio.com/). Must be version 1.101 or later.
19+
- [GitHub Copilot in Visual Studio Code](https://code.visualstudio.com/docs/copilot/overview). For setup instructions, see [Set up GitHub Copilot in Visual Studio Code](https://code.visualstudio.com/docs/copilot/setup). Be sure to sign in to your GitHub account within Visual Studio Code.
20+
- [GitHub Copilot app modernization](https://marketplace.visualstudio.com/items?itemName=vscjava.migrate-java-to-azure). Restart Visual Studio Code after installation.
21+
- The latest version of [IntelliJ IDEA](https://www.jetbrains.com/idea/download). Must be version 2023.3 or later.
22+
- [GitHub Copilot](https://plugins.jetbrains.com/plugin/17718-github-copilot). Must be version 1.5.59 or later. For more instructions, see [Set up GitHub Copilot in IntelliJ IDEA](https://docs.github.com/en/copilot/get-started/quickstart). Be sure to sign in to your GitHub account within IntelliJ IDEA.
23+
- [GitHub Copilot app modernization](https://plugins.jetbrains.com/plugin/28791-github-copilot-app-modernization). Restart IntelliJ IDEA after installation. If you don't have GitHub Copilot installed, you can install GitHub Copilot app modernization directly.
24+
- For more efficient use of Copilot in app modernization: in the IntelliJ IDEA settings, select the **Tools** > **GitHub Copilot** configuration window, and then select **Auto-approve** and **Trust MCP Tool Annotations**. For more information, see [Configure settings for GitHub Copilot app modernization to optimize the experience for IntelliJ](configure-settings-intellij.md).
25+
- [Java JDK](/java/openjdk/download) for both the source and target JDK versions.
26+
- [Maven](https://maven.apache.org/download.cgi) or [Gradle](https://gradle.org/install/) to build Java projects.
27+
- A Git-managed Java project using Maven or Gradle.
28+
- For Maven-based projects: access to the public Maven Central repository.
29+
- In the Visual Studio Code settings, make sure `chat.extensionTools.enabled` is set to `true`. This setting might be controlled by your organization.
30+
31+
> Note: If you're using Gradle, only the Gradle wrapper version 5+ is supported. The Kotlin Domain Specific Language (DSL) isn't supported.
32+
>
33+
> The function `My Tasks` isn't supported yet for IntelliJ IDEA.
34+
35+
## Clone the Repository
36+
37+
```bash
38+
git clone https://github.com/copilot-dev-days/appmod-workshop-java.git
39+
cd appmod-workshop-java
40+
```
41+
42+
## Install GitHub Copilot app modernization
43+
44+
In VSCode, open the Extensions view from the Activity Bar, search for the `GitHub Copilot app modernization` extension in the marketplace. Click the Install button for the extension. After installation completes, you should see a notification in the bottom-right corner of VSCode confirming success.
45+
46+
**Alternative: IntelliJ IDEA**
47+
Alternatively, you can use IntelliJ IDEA. Open **File** > **Settings** (or **IntelliJ IDEA** > **Preferences** on macOS), navigate to **Plugins** > **Marketplace**, search for `GitHub Copilot app modernization`, and click **Install**. Restart IntelliJ IDEA if prompted.
48+
49+
## Assess Your Java Application
50+
51+
The first step is to assess the sample Java application `asset-manager`. The assessment provides insights into the application's readiness for migration to Azure.
52+
53+
1. Open VS Code with all the prerequisites installed for the asset manager by changing the directory to the `asset-manager` directory and running `code .` in that directory.
54+
1. Open the `GitHub Copilot app modernization` extension.
55+
1. In the **QUICKSTART** view, click the **Migrate to Azure** button to trigger app assessment.
56+
57+
![Trigger Assessment](doc-media/trigger-assessment.png)
58+
59+
1. Wait for the assessment to be completed and the report to be generated.
60+
1. Review the **Assessment Report**. Select the **Issues** tab to view the proposed solutions for the issues identified in the report.
61+
62+
## Upgrade Runtime & Frameworks
63+
64+
1. In the **Java Upgrade** table at the bottom of the **Issues** tab, click the **Run Task** button of the first entry **Java Version Upgrade**.
65+
66+
![Java Upgrade](doc-media/java-upgrade.png)
67+
1. After clicking the **Run Task** button, the Copilot Chat panel will open with Agent Mode. The agent will check out a new branch and start upgrading the JDK version and Spring/Spring Boot framework. Click **Allow** for any requests from the agent.
68+
69+
> Note: The upgrading tool also supports upgrading to JDK 25 (the latest LTS version). To do this, click on the generated chat message, edit the target Java version to 25, and then click **Send** to apply the change.
70+
71+
## Expose health endpoints using Custom Tasks
72+
73+
In this section, you will use custom tasks to expose health endpoints for your applications instead of writing code yourself. The following steps demonstrate how to generate custom tasks based on external web links and proper prompts.
74+
75+
> Note: Custom tasks are not supported for the IntelliJ IDEA plugin. If you are using IntelliJ IDEA, you can skip this section.
76+
77+
1. Open the sidebar of `GITHUB COPILOT APP MODERNIZATION`. Click the `+` button in the **Tasks** view to create a custom task.
78+
79+
![Create Formula From Source Control](doc-media/create-formula-from-source-control.png)
80+
1. In the opened tab, enter the **Task Name** and **Task Prompt** as shown below:
81+
- **Task Name**: Expose health endpoint via Spring Boot Actuator
82+
- **Task Prompt**: You are a Spring Boot developer assistant, follow the Spring Boot Actuator documentation to add basic health endpoints for Azure Container Apps deployment.
83+
1. Click the **Add References** button to add the Spring Boot Actuator official documentation as references.
84+
85+
![Health endpoint task](doc-media/health-endpoint-task.png)
86+
1. In the popped-up quick-pick window, select **External links**. Then paste the following link: `https://docs.spring.io/spring-boot/reference/actuator/endpoints.html`. Click **Save** to create the task.
87+
1. Click the **Run** button to trigger the custom task.
88+
1. Follow the same steps as the predefined task to review and apply the changes.
89+
1. Review the proposed code changes and click **Keep** to apply them.
90+
91+
## Containerize Applications
92+
93+
Now that you have completed the upgrade and health endpoint steps, the next step is to prepare your application for cloud deployment by containerizing both the web and worker modules. In this section, you will use **Containerization Tasks** to containerize your applications.
94+
95+
1. Open the sidebar of `GITHUB COPILOT APP MODERNIZATION`. In **Tasks** view, click the **Run Task** button of **Java** -> **Containerization Tasks** -> **Containerize Application**.
96+
97+
![Run Containerize Application task](doc-media/containerization-run-task.png)
98+
99+
1. A predefined prompt will be populated in the Copilot Chat panel with Agent Mode. Copilot Agent will start to analyze the workspace and to create a **containerization-plan.copiotmd** with the containerization plan.
100+
101+
![Containerization prompt and plan](doc-media/containerization-plan.png)
102+
1. View the plan and collaborate with Copilot Agent as it follows the **Execution Steps** in the plan by clicking **Continue**/**Allow** in pop-up chat notifications to run commands. Some of the execution steps leverage agentic tools of **Container Assist**.
103+
104+
<!-- ![Containerization execution steps](doc-media/containerization-execution-steps.png) -->
105+
1. Copilot Agent will help generate Dockerfile, build Docker images and fix build errors if there are any. Click **Keep** to apply the generated code.

0 commit comments

Comments
 (0)