Personalización del plan de actualización del proyecto de Java al usar la modernización de GitHub Copilot

En este artículo se describe cómo personalizar el plan de actualización de proyectos de Java generado por la modernización de GitHub Copilot.

Al iniciar una sesión de actualización, GitHub Copilot genera un archivo plan.md que describe los pasos y tareas necesarios para la actualización. Este archivo sirve como plano técnico para el proceso de actualización, que puede personalizar para adaptarse mejor a las necesidades del proyecto.

Una vez que la herramienta genera el archivo plan.md , se abre automáticamente en el editor de Visual Studio Code. En esta fase, puede revisar y personalizar el plan para asegurarse de que se alinea con sus objetivos de actualización específicos.

Estructura de archivo ejemplo plan.md

En las secciones siguientes se describe un ejemplo plan.md estructura de archivos para ilustrar los puntos de personalización.

Parámetros clave

En las secciones siguientes se describen los parámetros clave del plan que puede modificar.

Opciones de comando de la herramienta de compilación

En la sección Herramientas disponibles , el agente detecta las herramientas de compilación (Maven o Gradle) y las rutas de acceso de JDK. Si necesita parámetros de línea de comandos personalizados para la ejecución de la compilación, agréguelos a la sección Directrices .

Ejemplos:

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

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

Personaliza los objetivos de actualización y proporciona directrices

En escenarios de actualización de Java, a menudo necesita personalización más allá de las actualizaciones estándar de JDK o del marco; por ejemplo, para aplicar cambios de código específicos del proyecto o para actualizar bibliotecas internas, la herramienta no detecta automáticamente. Para admitir estas necesidades, la modernización de GitHub Copilot ahora habilita la personalización dentro del plan de actualización. Esta funcionalidad le permite proporcionar sus propias recetas, instrucciones y entradas para guiar el proceso de actualización. Puede realizar esta personalización modificando las secciones Objetivos y directrices de actualización.

Sección Objetivos de actualización

En la sección Objetivos de actualización , especifique más objetivos de actualización junto con los objetivos de la solicitud inicial. Por ejemplo, si la tarea principal es actualizar el proyecto de Java 17 a Java 21, pero el proyecto también requiere actualizar Log4j de 1.x a 2.x, enumere ese requisito como objetivo adicional, como se muestra en el símbolo del ejemplo siguiente:

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

La sección Directrices

En la sección Directrices se define cómo debe realizar Copilot la actualización. Aunque la sección Objetivos de actualización se centra en lo que se debe actualizar, la sección Directrices captura la metodología, las convenciones, las herramientas y las reglas que guían el comportamiento de Copilot durante la transformación del código.

Incluya las instrucciones que ayuden a dirigir cómo Copilot modifica el código, como las siguientes instrucciones:

• Instrucciones sobre qué herramientas, recetas o marcos se usarán para los cambios de código.
• Restricciones o prohibiciones sobre determinados enfoques de actualización.
• Requisitos de estilo de código o convención.
• Vínculos a archivos internos, documentación o scripts a los que puede acceder el agente.
• Conocimientos de dominio útiles para corregir errores o realizar actualizaciones.
• Requisitos para cómo el agente debe anotar o comentar los cambios en el código.
• Instrucciones de limpieza de artefactos temporales creados durante el proceso de actualización.

El contenido de esta sección puede ser texto sin formato, hipervínculos o referencias a archivos locales siempre que Copilot pueda acceder a ellos.

Ejemplos:

## 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.

Consulte también

Modernización de GitHub Copilot