Konsep cetak biru kustom

Berikut adalah beberapa konsep dan istilah yang harus Anda ketahui saat bekerja dengan cetak biru khusus di. CodeCatalyst

Proyek cetak biru

Proyek cetak biru memberi Anda kemampuan untuk mengembangkan dan mempublikasikan cetak biru ke ruang Anda. Repositori sumber dibuat selama proses pembuatan proyek, dan nama repositori adalah yang Anda pilihsaat memasukkan detail sumber daya Proyek. Selama proses pembuatan cetak biru, jika Anda memilih untuk menghasilkan rilis alur kerja, alur kerja penerbitan dibuat dalam cetak biru Anda dengan cetak biru Blueprint Builder. Alur kerja secara otomatis menerbitkan versi terbaru Anda.

Cetak biru luar angkasa

Anda dapat melihat dan mengelola semua cetak biru dari tabel cetak biru Space saat Anda menavigasi ke bagian Cetak Biru di ruang Anda. Setelah cetak biru dipublikasikan ke ruang Anda, mereka tersedia sebagai cetak biru ruang untuk ditambahkan dan dihapus dari katalog cetak biru ruang Anda. Anda juga dapat mengelola izin penerbitan dan menghapus cetak biru dari bagian Cetak Biru di ruang Anda. Untuk informasi selengkapnya, lihat Melihat detail, versi, dan proyek cetak biru kustom.

Katalog cetak biru luar angkasa

Anda dapat melihat semua cetak biru kustom yang ditambahkan dari katalog cetak biru ruang. Di sinilah anggota ruang dapat memilih cetak biru kustom Anda untuk membuat proyek baru. Katalog ini berbeda dengan CodeCatalyst katalog, yang sudah memiliki cetak biru yang tersedia untuk semua anggota ruang angkasa. Untuk informasi selengkapnya, lihat Membuat proyek yang komprehensif dengan CodeCatalyst cetak biru.

Sintesis

Sintesis adalah proses menghasilkan bundel CodeCatalyst proyek yang mewakili kode sumber, konfigurasi, dan sumber daya dalam sebuah proyek. Bundel ini kemudian digunakan oleh operasi API CodeCatalyst penerapan untuk menyebarkan ke dalam proyek. Prosesnya dapat dijalankan secara lokal sambil mengembangkan cetak biru khusus Anda untuk meniru pembuatan proyek tanpa harus membuat proyek. CodeCatalyst Perintah berikut dapat digunakan untuk melakukan sintesis:

yarn blueprint:synth             # fast mode
yarn blueprint:synth --cache     # wizard emulation mode

Cetak biru dimulai dengan sendirinya dengan memanggil blueprint.ts kelas utama dengan opsi yang digabungkan. defaults.json Bundel proyek baru dihasilkan di bawah synth/synth.[options-name]/proposed-bundle/ folder. Outputnya mencakup bundel proyek yang dihasilkan cetak biru kustom, mengingat opsi yang Anda tetapkan, termasuk opsi sebagian yang mungkin telah Anda konfigurasikan.

Resintesis

Resintesis adalah proses regenerasi cetak biru dengan opsi cetak biru yang berbeda atau versi cetak biru dari proyek yang ada. Sebagai penulis cetak biru, Anda dapat menentukan strategi penggabungan kustom dalam kode cetak biru kustom. Anda juga dapat menentukan batas kepemilikan dalam .ownership-file untuk menentukan di bagian mana dari basis kode cetak biru diizinkan untuk diperbarui. Sementara cetak biru kustom dapat mengusulkan pembaruan ke.ownership-file, pengembang proyek yang menggunakan cetak biru khusus dapat menentukan batas kepemilikan untuk proyek mereka. Anda dapat menjalankan resynthesis secara lokal, dan menguji serta memperbarui sebelum menerbitkan cetak biru kustom Anda. Gunakan perintah berikut untuk melakukan resintesis:

yarn blueprint:resynth             # fast mode
yarn blueprint:resynth --cache     # wizard emulation mode

Cetak biru dimulai dengan sendirinya dengan memanggil blueprint.ts kelas utama dengan opsi yang digabungkan. defaults.json Bundel proyek baru dihasilkan di bawah synth/resynth.[options-name]/ folder. Outputnya mencakup bundel proyek yang dihasilkan cetak biru kustom, mengingat opsi yang Anda tetapkan, termasuk opsi sebagian yang mungkin telah Anda konfigurasikan.

Isi berikut dibuat setelah proses sintesis dan resintesis:

• proposed-bundle - Output sintesis ketika dijalankan dengan opsi baru untuk versi cetak biru target.

• existing-bundle - Sebuah tiruan dari proyek Anda yang ada. Jika tidak ada apa pun di folder ini, itu dihasilkan dengan output yang sama seperti diaproposed-bundle.

• ancestor-bundle - Sebuah tiruan dari apa yang akan dihasilkan cetak biru Anda saat dijalankan dengan versi sebelumnya, opsi sebelumnya, atau kombinasi. Jika tidak ada apa pun di folder ini, itu dihasilkan dengan output yang sama dengan fileproposed-bundle.

• resolved-bundle - Bundel selalu dibuat ulang dan default menjadi penggabungan tiga arah antara,, dan. proposed-bundle existing-bundle ancestor-bundle Bundel ini memberikan emulasi tentang apa yang akan dihasilkan resintesis secara lokal.

Untuk mempelajari lebih lanjut tentang bundel keluaran cetak biru, lihat. Menghasilkan file dengan resynthesis

Opsi sebagian

Anda dapat menambahkan variasi opsi di bawah src/wizard-configuration/ yang tidak harus menghitung keseluruhan Options antarmuka, dan opsi digabungkan di atas file. defaults.json Itu memungkinkan Anda untuk menyesuaikan kasus uji di seluruh opsi tertentu.

Contoh:

OptionsAntarmuka:

{
  language: "Python" | "Java" | "Typescript",
  repositoryName: string
  ...
}

defaults.jsonberkas:

{
  language: "Python",
  repositoryName: "Myrepo"
  ...
}

Tes konfigurasi tambahan:

• #wizard-config-typescript-test.json
  {
    language: "Typescript",
  }

• #wizard-config-java-test.json
  {
    language: "Java",
  }

Projen

Projen adalah alat sumber terbuka yang digunakan cetak biru khusus untuk menjaga diri mereka diperbarui dan konsisten. Cetak biru datang sebagai paket Projen karena kerangka kerja ini memberi Anda kemampuan untuk membangun, menggabungkan, dan menerbitkan proyek, dan Anda dapat menggunakan antarmuka untuk mengelola konfigurasi dan pengaturan proyek.

Anda dapat menggunakan Projen untuk memperbarui cetak biru dalam skala besar, bahkan setelah mereka dibuat. Alat Projen adalah teknologi yang mendasari di balik sintesis cetak biru yang menghasilkan bundel proyek. Projen memiliki konfigurasi untuk sebuah proyek, dan seharusnya tidak memengaruhi Anda sebagai penulis cetak biru. Anda dapat menjalankan yarn projen untuk membuat ulang konfigurasi proyek Anda setelah menambahkan dependensi, atau Anda dapat mengubah opsi dalam file. projenrc.ts Projen juga merupakan alat generasi yang mendasari cetak biru khusus untuk mensintesis proyek. Untuk informasi lebih lanjut, lihat GitHub halaman projen. Untuk mempelajari lebih lanjut tentang bekerja dengan Projen, lihat dokumentasi Projen dan Cara menyederhanakan penyiapan proyek dengan Projen.