Menerbitkan semula gimme_readme ke npm dengan Tindakan GitHub

Minggu ini dalam kelas Sumber Terbuka saya, rakan sekelas saya dan saya ditugaskan untuk menerbitkan setiap program kami sendiri ke daftar pakej.

Apabila anda mendengar seseorang menyebut pendaftaran kod, pendaftaran pakej atau pendaftaran, saya suka menganggap perkataan ini sebagai mewakili tempat pembangun dan syarikat menerbitkan kod mereka untuk dimuat turun oleh orang lain. Untuk penerangan yang lebih tepat, anda boleh membaca artikel oleh Mozilla ini:

Asas pengurusan pakej - Belajar pembangunan web | MDN

Ini membawa kami ke penghujung lawatan pengurus pakej kami. Langkah seterusnya kami ialah membina rantai alat sampel, mempraktikkan semua yang telah kami pelajari setakat ini.

gimme_readme - npm

gimme_readme ialah alat baris perintah yang dikuasakan oleh AI yang menjana fail README.md yang komprehensif untuk projek anda. Ia menganalisis berbilang fail kod sumber sekaligus, memberikan penjelasan ringkas tentang tujuan, fungsi dan komponen utama setiap fail. Versi terkini: 1.0.0, terakhir diterbitkan: 16 jam yang lalu. Mula menggunakan gimme_readme dalam projek anda dengan menjalankan `npm i gimme_readme`. Tiada projek lain dalam pendaftaran npm menggunakan gimme_readme.

Seperti yang anda lihat di atas, terdapat banyak folder dan fail yang tidak diperlukan untuk dimiliki oleh pengguna (berbanding dengan pembangun). Sebagai contoh, adakah anda fikir pengguna saya mahu folder "ujian" saya menguji kod program saya? Mungkin tidak. Adakah anda fikir pengguna saya memerlukan fail konfigurasi yang diperlukan untuk memformat dan menyelitkan kod sumber saya? Mungkin tidak. Adakah anda fikir pengguna saya perlu menggunakan folder ".github" saya untuk sebarang sebab tertentu? Mungkin tidak.

Untuk tujuan ini, saya telah berusaha untuk mencari penyelesaian untuk meminimumkan perkara yang dimuat turun oleh pengguna; khususnya, saya mahu mereka hanya mempunyai kod sumber yang diperlukan untuk program saya dijalankan.

Untuk .npmignore atau untuk tidak .npmignore? Itulah persoalannya.

Ketika saya berfikir untuk menerbitkan semula kod saya, saya juga bercakap dengan rakan saya Uday Rana, tentang idea menggunakan fail .npmignore untuk "mengabaikan" fail yang saya tidak mahu terbitkan.

Sejurus selepas saya menyebut topik itu, Uday Googled .npmignore, dan menemui artikel yang ditulis oleh Jeff D tentang mengapa seseorang itu harus tidak sesekali menggunakan fail .npmignore. Untuk menjadi jelas, saya sepenuh hati bersetuju dengan artikel Jeff.

Pada asasnya, ideanya ialah kita harus eksplisit dengan perkara yang mahu terbitkan (penyenaraian putih), berbanding menyatakan fail mana yang tidak mahu menerbitkan (senarai hitam).

Menyenarai putih fail yang ingin kami terbitkan adalah mudah dengan npm. Apa yang perlu kami lakukan ialah mengedit fail package.json kami dengan menambahkan pilihan "fail", yang menunjukkan fail yang ingin kami terbitkan untuk program kami.

Di bawah, saya telah mengambil tangkapan skrin bagi pilihan "fail" package.json, yang menyatakan, "sertakan direktori src/ semasa menerbitkan program ini". Sejak itu saya telah melakukan perubahan ini dan perubahan ini tersedia dalam keluaran v1.0.0 saya bagi kod saya.

NOTA: Fail tertentu secara lalai, sentiasa diterbitkan kepada npm, tidak kira apa yang anda tentukan atau tidak tentukan dalam pilihan "fail" anda. Jika anda ingin mengetahui lebih lanjut tentang cara menggunakan pilihan "fail", lihat dokumentasi rasmi npm tentang cara menggunakan pilihan fail.

Selepas menerbitkan kod saya ke npm dengan package.json saya yang dikemas kini, pengguna yang memasang/memasang semula gimme_readme kini akan mempunyai lebih banyak kekurangan pada komputer mereka! Lihat perbezaan di bawah:

Menambah tindakan GitHub untuk menerbitkan kod saya ke npm apabila saya menambah keluaran baharu

Selain meningkatkan pengalaman pengguna saya (dengan mengurangkan kelebihan yang datang daripada memasang gimme_readme melalui npm), saya juga menambah saluran pembangunan berterusan (pendek kata saluran paip cd) yang akan mengautomasikan proses penerbitan saya kepada npm apabila saya membuat yang baharu keluarkan pada GitHub. Untuk butiran tepat tentang cara melakukan ini, anda boleh merujuk kepada panduan pakej Penerbitan Node.js GitHub. Ini terasa baik sekarang, kerana dengan mengklik beberapa butang, saya dapat menerbitkan kod yang saya tahu stabil (mengikut saluran paip CI saya), dari GitHub.

Anda boleh mencari kod untuk saluran paip cd saya di sini.

Menguji dengan Uday

Seperti yang saya nyatakan sebelum ini, saya bekerja dengan rakan saya, Uday Rana, berkaitan dengan ujian. Pada masa penulisan, dia dapat memasang alat saya, dan menggunakannya seperti itu:

Perkara kelihatan baik bagi saya, dan kebanyakan pilihan yang saya ada untuk alat saya lebih kurang berkelakuan seperti yang dia jangkakan. Tetapi saya perlu mengulangi proses ini sekali lagi, kerana saya mempunyai beberapa pengoptimuman lanjut yang ingin saya tambahkan!

Perjalanan tidak pernah berakhir... tetapi itulah yang menjadikannya menyeronokkan!

Saya juga baru-baru ini mendengar tentang cara untuk mengoptimumkan kod saya dengan lebih lanjut. Terutamanya, saya melabur dalam mempelajari cara menambah baik saluran paip CI dan CD saya dengan mempelajari tentang tindakan komposit dan aliran kerja boleh guna semula berkaitan dengan tindakan GitHub. Harapan saya ialah teknik ini akan membantu saya mengurangkan jumlah kod yang saya tulis, dan menawarkan beberapa jenis peningkatan prestasi! Saya belum tahu banyak tentang topik ini, tetapi anda boleh bertaruh saya mungkin akan memblog tentangnya tidak lama lagi.

Dan rakan-rakan saya, menyimpulkan apa yang saya ingin bincangkan dalam blog ini.

Jumpa lagi nanti!

Atas ialah kandungan terperinci Menerbitkan semula gimme_readme ke npm dengan Tindakan GitHub. Untuk maklumat lanjut, sila ikut artikel berkaitan lain di laman web China PHP!