Het upgradeplan voor het Java-project aanpassen tijdens GitHub Copilot-modernisering

In dit artikel wordt beschreven hoe u het Java-projectupgradeplan aanpast dat is gegenereerd door de modernisering van GitHub Copilot.

Wanneer u een upgradesessie start, genereert GitHub Copilot een plan.md-bestand waarin de stappen en taken worden beschreven die nodig zijn voor de upgrade. Dit bestand fungeert als een blauwdruk voor het upgradeproces, dat u kunt aanpassen aan de behoeften van uw project.

Nadat het hulpprogramma het plan.md-bestand heeft gegenereerd, wordt het automatisch geopend in de Visual Studio Code-editor. In deze fase kunt u het plan controleren en aanpassen om ervoor te zorgen dat het overeenkomt met uw specifieke upgradedoelen.

Voorbeeld van plan.md bestandsstructuur

In de volgende secties wordt een voorbeeld van een plan.md bestandsstructuur beschreven om de aanpassingspunten te illustreren.

Sleutelparameters

In de volgende secties worden de belangrijkste parameters in het plan beschreven die u kunt wijzigen.

Opdrachtopties voor buildtool

In de sectie Beschikbare hulpprogramma's detecteert de agent uw buildhulpprogramma's (Maven of Gradle) en JDK-paden. Als u aangepaste opdrachtregelparameters nodig hebt voor het uitvoeren van de build, voegt u deze toe aan de sectie Richtlijnen .

Examples:

• Voor Maven: Use build options: -Dmaven.javadoc.skip=true -s "/path/to/custom/settings.xml"

• Voor Gradle: Use build options: --info -Penv=production

Opmerking

Vervang zo nodig het pad door de werkelijke settings bestandslocatie. Het weergegeven pad is slechts een voorbeeld.

Upgradedoelen aanpassen en richtlijnen bieden

In Java-upgradescenario's hebt u vaak aanpassingen nodig buiten standaard-JDK- of frameworkupgrades, bijvoorbeeld om projectspecifieke codewijzigingen toe te passen of interne bibliotheken bij te werken die het hulpprogramma niet automatisch detecteert. Ter ondersteuning van deze behoeften biedt GitHub Copilot-modernisering nu aanpassing binnen het upgradeplan. Met deze mogelijkheid kunt u uw eigen recepten, instructies en invoer opgeven om het upgradeproces te begeleiden. U kunt deze aanpassing uitvoeren door de secties Upgradedoelen en Richtlijnen te wijzigen.

De sectie Upgrade doelen

Geef in de sectie Upgradedoelen meer upgradedoelen op, samen met de doelstellingen in uw eerste prompt. Als de primaire taak bijvoorbeeld is om het project te upgraden van Java 17 naar Java 21, maar het project vereist ook een upgrade van Log4j van 1.x naar 2.x, vermeldt u die vereiste als een extra doel, zoals wordt weergegeven in de volgende voorbeeldprompt:

## Upgrade Goals
- Upgrade from Java 17 to 21
- Upgrade org.apache.logging.log4j:* to 2.24.3 
- Upgrade org.internal.lib to 2.0

De sectie Richtlijnen

In de sectie Richtlijnen wordt gedefinieerd hoe Copilot de upgrade moet uitvoeren. Hoewel de sectie Upgradedoelen zich richt op wat er moet worden bijgewerkt, legt de sectie Richtlijnen de methodologie, conventies, hulpprogramma's en regels vast die het gedrag van Copilot tijdens codetransformatie begeleiden.

Neem eventuele instructies op waarmee u kunt bepalen hoe Copilot code wijzigt, zoals de volgende instructies:

• Richtlijnen voor welke hulpprogramma's, recepten of frameworks moeten worden gebruikt voor codewijzigingen.
• Beperkingen of verbodsbepalingen voor bepaalde upgrademethoden.
• Codestijl- of conventieregels.
• Koppelingen naar interne bestanden, documentatie of scripts die de agent kan openen.
• Domeinkennis nuttig voor het oplossen van fouten of het uitvoeren van upgrades.
• Vereisten voor hoe de agent aantekeningen moet maken of commentaar moet toevoegen aan codewijzigingen.
• Opschoningsinstructies voor tijdelijke artefacten die tijdens het upgradeproces zijn gemaakt.

De inhoud van deze sectie kan tekst zonder opmaak, hyperlinks of verwijzingen naar lokale bestanden zijn, zolang Copilot er toegang toe heeft.

Examples:

## Guidelines
- Do not use Log4j 1 to Log4J 2 API bridge to upgrade to Log4J 2. 
- Please follow the code conventions defined in /xxx/bbb/rules.txt.
- Please provide detailed comments explaining why each code change is necessary.
- "com.example:internal-lib:2.0.0" is compatible with Java 21.
- Use our internal MCP tool get_internal_lib_knowledge to retrieve compatibility information for internal libraries.
- After the upgrade, please remove any temporary files created during the process, such as code modification scripts.

Zie ook

Modernisering van GitHub Copilot