Menyesuaikan rencana peningkatan proyek Java saat menggunakan modernisasi GitHub Copilot

Artikel ini menjelaskan cara menyesuaikan rencana peningkatan proyek Java yang dihasilkan oleh modernisasi GitHub Copilot.

Saat Anda memulai sesi peningkatan, GitHub Copilot menghasilkan file plan.md yang menguraikan langkah-langkah dan tugas yang diperlukan untuk peningkatan. File ini berfungsi sebagai cetak biru untuk proses peningkatan, yang dapat Anda sesuaikan agar lebih sesuai dengan kebutuhan proyek Anda.

Setelah alat menghasilkan file plan.md , alat tersebut secara otomatis terbuka di editor Visual Studio Code. Pada tahap ini, Anda dapat meninjau dan menyesuaikan rencana untuk memastikannya selaras dengan tujuan peningkatan spesifik Anda.

Contoh struktur berkas plan.md

Bagian berikut menjelaskan sampel plan.md struktur file untuk mengilustrasikan titik kustomisasi.

Parameter kunci

Bagian berikut ini menjelaskan parameter kunci dalam paket yang dapat Anda ubah.

Opsi perintah alat kompilasi

Di bagian Alat yang Tersedia, agen mendeteksi alat build Anda (Maven atau Gradle) dan jalur JDK. Jika Anda memerlukan parameter baris perintah kustom untuk eksekusi build, tambahkan parameter tersebut ke bagian Pedoman .

Examples:

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

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

Nota

Ganti jalur dengan lokasi file aktual settings Anda sesuai kebutuhan. Jalur yang ditampilkan hanyalah contoh.

Screenshot paket peningkatan Java yang memperlihatkan bagian Alat, Panduan, Opsi, dan Tujuan Peningkatan yang Tersedia.

Menyesuaikan tujuan peningkatan dan memberikan panduan

Dalam skenario peningkatan Java, Anda sering memerlukan penyesuaian di luar peningkatan JDK atau kerangka kerja standar - misalnya, untuk menerapkan perubahan kode khusus proyek atau untuk memperbarui pustaka internal yang tidak dideteksi alat secara otomatis. Untuk mendukung kebutuhan ini, modernisasi GitHub Copilot sekarang memungkinkan penyesuaian dalam paket peningkatan. Kemampuan ini memungkinkan Anda untuk memberikan resep, instruksi, dan input Anda sendiri untuk memandu proses peningkatan. Anda dapat melakukan penyesuaian ini dengan memodifikasi bagian Tujuan peningkatan dan Pedoman .

Bagian Tujuan Peningkatan

Di bagian Tingkatkan Tujuan , tentukan lebih banyak target peningkatan bersama dengan tujuan di prompt awal Anda. Misalnya, jika tugas utama adalah meningkatkan proyek dari Java 17 ke Java 21, tetapi proyek juga memerlukan peningkatan Log4j dari 1.x ke 2.x, mencantumkan persyaratan tersebut sebagai tujuan tambahan, seperti yang ditunjukkan dalam contoh prompt berikut:

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

Bagian Panduan

Bagian Pedoman menentukan bagaimana Copilot harus melakukan peningkatan. Sementara bagian Sasaran Peningkatan berfokus pada apa yang perlu ditingkatkan, bagian Pedoman mengambil metodologi, konvensi, alat, dan aturan yang memandu perilaku Copilot selama transformasi kode.

Sertakan instruksi apa pun yang membantu mengarahkan cara Copilot memodifikasi kode, seperti instruksi berikut:

  • Panduan tentang alat, resep, atau kerangka kerja mana yang akan digunakan untuk perubahan kode.
  • Batasan atau larangan pada pendekatan peningkatan tertentu.
  • Gaya kode atau persyaratan konvensi.
  • Tautan ke file internal, dokumentasi, atau skrip yang dapat diakses agen.
  • Pengetahuan domain berguna untuk memperbaiki kesalahan atau melakukan peningkatan.
  • Persyaratan tentang bagaimana agen harus membuat anotasi atau mengomentari perubahan kode.
  • Instruksi pembersihan untuk artefak sementara yang dibuat selama proses peningkatan.

Konten bagian ini bisa berupa teks biasa, hyperlink, atau referensi ke file lokal selama Copilot dapat mengaksesnya.

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.

Lihat juga

Modernisasi GitHub Copilot