Menggunakan Subversion dengan Direktori Plugin WordPress

Diterbitkan: 2012-07-24

Ikuti petunjuk langkah demi langkah ini untuk menambahkan dan memperbarui plugin di Direktori Plugin WordPress publik.

Langkah-langkah penting dari video berikut ini:

  • Memulai dengan Plugin Anda
  • Daftar untuk Akun WordPress.org
  • Permintaan untuk Menempatkan Plugin Baru Anda di Direktori Plugin WordPress
  • Instal Klien SVN Untuk Mesin Anda
  • Pilih Direktori Lokal untuk Proyek Anda
  • Email Persetujuan Permintaan Plugin Anda
  • Ketentuan Direktori untuk Artikel Ini
  • Menarik Direktori Server Baru ke Mesin Lokal Anda
  • Selesai Mengembangkan Plugin Anda
  • Jadikan Versi Pertama Anda Tersedia untuk Umum
    • Memperbarui batang direktori proyek
    • Menandai versi baru di server
    • Memperbarui direktori proyek lokal Anda dengan versi baru yang diberi tag
    • Memperbarui tag stabil readme.txt
  • Perkembangan Baru untuk Plugin Anda

Memulai dengan Plugin Anda

Baik Anda baru saja memiliki ide atau hampir selesai dengan versi 0.1, Anda memerlukan nama dan deskripsi untuk plugin Anda. Buat nama tersebut singkat dan deskriptif, dengan memberikan gambaran tentang apa yang dilakukan plugin. "Wax on Wax off Plugin" bukanlah nama yang bagus. "Drop Shadow Maker" jauh lebih baik. Anda tidak perlu menambahkan "Plugin" ke judul sebenarnya.

Untuk mengikuti judul Anda, Anda harus menulis deskripsi singkat yang memberi tahu orang-orang apa manfaat yang diberikan plugin Anda. Saya merekomendasikan deskripsi ini di bawah 150 karakter.

Daftar untuk Akun WordPress.org

Jika Anda belum memiliki akun WordPress.org–digunakan untuk berinteraksi di forum dukungan dan sejenisnya–Anda harus mendapatkannya. Cukup buka: https://login.wordpress.org/register

Permintaan untuk Menempatkan Plugin Baru Anda di Direktori Plugin WordPress

Plugin paling masuk akal yang dikirimkan dengan lisensi yang kompatibel bisa mendapatkan ruang di Direktori Plugin WordPress.

  1. Pergi ke: http://wordpress.org/extend/plugins/add/
  2. Isi Judul dan Deskripsi Anda
    (Saya katakan Anda akan membutuhkan itu!)
  3. Lewati pengunggahan plugin Anda dari formulir ini–bahkan jika plugin Anda siap digunakan.

Permintaan direktori plugin Anda diproses oleh orang sungguhan, jadi mungkin perlu beberapa saat.

Instal Klien SVN untuk Mesin Anda

Untuk bekerja dengan Direktori Plugin, Anda memerlukan klien Subversion di mesin Anda.

  • Untuk Windows, saya merekomendasikan TortoiseSVN.
  • Untuk Mac, sepertinya SCPlugin adalah paket yang bagus.

Cukup pilih satu dan pasang. Tidak banyak lagi yang bisa dikatakan tentang itu.

Pilih Direktori Lokal untuk Proyek Anda

Subversion akan terus memperbarui salinan lokal file plugin Anda dengan Direktori Plugin WordPress. Saya sarankan membuat satu direktori di mesin lokal Anda di mana Anda akan menyimpan semua proyek yang dilacak Subversion Anda. Perhatian: Jika Anda memiliki lingkungan pengembangan web di mesin lokal Anda, jangan tergoda untuk menggunakan direktori plugin WordPress server web lokal Anda sebagai direktori proyek Anda.

Misalnya, jika Anda memiliki instalasi WordPress lokal di mesin Anda di mana folder plugins berada:

documents/public_html/devdomain.com/wp-content/plugins/

…jangan berpikir Anda dapat menggunakan direktori itu untuk menyinkronkan proyek Direktori Plugin WordPress Anda. Itu akan membuatmu kesakitan.

Sebagai gantinya, buat direktori seperti contoh ini:

documents/projects/wp-plugins-public/

Setiap folder proyek plugin Anda akan masuk ke dalam “wp-plugins-public.” Untuk tutorial ini, saya akan menggunakan folder plugin bernama “content-scheduler.” Jadi, saya akan membuat direktori seperti itu:

documents/projects/wp-plugins-public/content-scheduler

Email Persetujuan Permintaan Plugin Anda

Setelah permintaan plugin Anda disetujui, Anda akan menerima email dengan tautan ke repositori SVN Anda. Ini khusus untuk satu plugin itu, dan diperlukan untuk melanjutkan sinkronisasi Subversion Anda.

Ketentuan Direktori untuk Artikel Ini

Dengan begitu banyak direktori, proyek, dan folder berbeda yang disebutkan dalam artikel ini, mungkin mudah untuk menjadi bingung. Mari kita sepakati tiga lokasi berbeda saat bekerja dengan alur kerja Subversion ini.

  1. Direktori kerja
    Ini adalah salinan kode saat ini yang Anda ubah dan uji. Itu harus berada di folder “/wp-content/plugins/” di server web pengembangan Anda. Di mesin saya, kebetulan:
    documents/public_html/devdomain.com/wp-content/plugins/content-scheduler/
  2. Direktori proyek
    Ini adalah direktori yang akan tetap disinkronkan klien Subversion Anda dengan Direktori Plugin WordPress. Di mesin saya, ini adalah:
    documents/projects/wp-plugins-public/content-scheduler/
  3. Direktori server
    Ini merujuk pada proyek Anda yang disimpan di Direktori Plugin WordPress. Di sinilah publik akan bisa mendapatkan plugin Anda. Lokasi root disebut “repositori SVN” Anda, dan akan diberikan kepada Anda dalam email persetujuan permintaan plugin Anda. Untuk contoh saya, ini adalah:
    http://plugins.svn.wordpress.org/content-scheduler

Menarik Direktori Server Baru ke Mesin Lokal Anda

Meskipun Anda belum meletakkan file apa pun di lokasi plugin baru Anda di Direktori Plugin, Anda perlu menarik salinan direktori itu ke mesin Anda. Melakukannya akan menetapkan beberapa tanda di belakang layar untuk membantu klien Subversion Anda mengetahui apa yang terbaru dan apa yang tidak.

  1. Klik kanan folder plugin direktori proyek Anda.
  2. Pilih "Pembayaran SVN".
  3. Masukkan URL repositori SVN WordPress Anda (dari email persetujuan Anda) ke bidang pertama.
  4. Folder plugin direktori proyek Anda harus berada di bidang kedua.
    Karena Anda memulai proses ini dengan mengklik kanan folder itu, bidang ini seharusnya sudah diisi.
  5. Klik “Oke”

Selesai Mengembangkan Plugin Anda

Kembangkan dan uji plugin Anda. Ini termasuk membuat file "readme.txt" yang tepat untuk menyertainya. File "readme.txt" bukan hanya beberapa catatan acak tentang plugin Anda. Direktori Plugin WordPress menggunakan konten file "readme.txt" untuk memahami versi plugin Anda yang dianggap terkini, dan juga untuk membuat konten halaman plugin Anda di Direktori.

  • Untuk informasi lebih lanjut tentang membuat file “readme.txt” yang tepat, lihat contoh readme.txt WordPress ini.

Bagian penting dari file "readme.txt" Anda adalah tag "Stabil". Saat Anda mengembangkan plugin, biarkan tag ini bertuliskan “trunk.” Setelah Anda merilis versi untuk konsumsi publik, kami akan memperbaruinya dengan nomor versi yang benar.

Jadikan Versi Pertama Anda Tersedia untuk Umum

Memperbarui batang direktori proyek

  1. Salin konten direktori kerja Anda ke folder "trunk" dari direktori proyek Anda.
    Dalam kasus saya, saya menyalin seluruh konten plugin saya dari direktori kerja:
    /documents/public_html/devdomain.com/wp-content/plugins/content-scheduler/
    ke direktori proyek saya:
    /documents/projects/wp-plugins-public/content-scheduler/
  2. Klik kanan folder plugin “penjadwal konten” di direktori proyek Anda dan pilih “SVN Commit.”
  3. Masukkan komentar untuk komit jika Anda mau.
  4. Tinjau daftar file yang dianggap baru dan akan disalin ke server. Jika daftar ini terlihat akurat, klik "OK" dan file akan disalin ke direktori server Anda di wordpress.org.

Menandai versi baru di server

Anda telah memperbarui file di “trunk”, tetapi bukan ini yang seharusnya diunduh oleh publik. Anda perlu menggunakan "tagging" untuk membuat salinan "trunk". Salinan ini tidak akan diubah lebih lanjut, dan akan ditawarkan untuk penggunaan umum. Untuk contoh ini, mari kita buat versi 1.0.

  1. Klik kanan pada folder "trunk" direktori proyek dan pilih "Cabang/Tag."
    Bagi saya, ini adalah:
    /documents/projects/wp-plugins-public/content-scheduler/trunk/
  2. Bidang lokasi "Ke URL" akan diakhiri dengan "/ trunk." Anda perlu mengubahnya menjadi “/tags/1.0” untuk membuat versi 1.0.
  3. Anda dapat menambahkan catatan tentang operasi penandaan ini jika Anda mau.
  4. Klik "OK," dan abaikan pesan apa pun tentang "penting untuk diubah ke cabang ini ..."

Memperbarui direktori proyek lokal Anda dengan versi baru yang diberi tag

Anda baru saja memberi tahu server untuk membuat salinan baru dari file proyek Anda di direktori “/tags/1.0”. Sekarang, kita perlu memperbarui direktori proyek lokal Anda dengan tag baru itu.

Proses ini mungkin tampak aneh. Anda mungkin bertanya-tanya mengapa Anda tidak bisa membuat salinan sendiri di direktori lokal “/tags/1.0”. Jika Anda melakukannya, direktori server dan direktori proyek bisa menjadi berantakan dan bingung tentang apa yang diperbarui dan apa yang tidak.

  • Klik kanan direktori proyek lagi dan pilih "SVN Update."
    Ini menarik perubahan dari direktori server ke direktori proyek lokal Anda. Dalam hal ini, perubahannya adalah penambahan salinan “/tags/1.0” dari file Anda.

Memperbarui tag stabil readme.txt

Semua file yang tepat tersedia bagi publik untuk menggunakan plugin Anda. Namun, kami harus memberi tahu Direktori Plugin versi tag mana yang harus digunakan publik.

  1. Edit file “readme.txt” di folder “trunk” direktori proyek lokal Anda.
    Bagi saya, ini adalah sebagai berikut:
    /documents/projects/wp-plugins-public/content/scheduler/trunk/readme.txt
  2. Ubah "Tag Stabil" ke versi rilis Anda, "1.0"
  3. Simpan filenya
  4. Klik kanan file “readme.txt” yang baru saja Anda perbarui dan pilih “SVN Commit.”

Itu dia! Dalam 15 menit atau lebih:

  1. Direktori Plugin WordPress akan memperbarui daftar proyek Anda
  2. "1.0" akan terlihat sebagai tag stabil
  3. Informasi dalam “/tags/1.0/readme.txt” akan digunakan untuk mengisi halaman proyek Anda.

Perkembangan Baru untuk Plugin Anda

Kemungkinan besar, Anda akan membuat peningkatan pada plugin Anda dan perlu memublikasikannya. Inilah cara kerjanya.

  1. Buat perubahan pada plugin di direktori kerja Anda.
    Perubahan ini harus mencakup perubahan pada file readme.txt sesuai kebutuhan, seperti entri Changelog.
  2. Salin perubahan dari direktori kerja Anda ke direktori proyek lokal Anda.
  3. Pastikan file readme.txt memiliki tag “stabil” yang benar untuk versi publik saat ini.
  4. Klik kanan direktori proyek dan pilih "SVN Commit" untuk memasukkan perubahan batang baru Anda ke direktori server.
  5. Klik kanan direktori "trunk" di direktori proyek Anda dan pilih "Cabang/Tag" untuk membuat tag versi baru untuk rilis. (Pastikan "Buat salinan dalam repositori dari:" diatur ke "Salinan kerja.")
  6. Klik kanan direktori proyek dan pilih "SVN Update" untuk menarik perubahan tag dari direktori server.
  7. Perbarui tag stabil di file “/trunk/readme.txt” direktori proyek agar sesuai dengan tag rilis baru yang Anda buat.
  8. Klik kanan direktori proyek (ya, sekali lagi) dan pilih "SVN Commit" untuk mendapatkan file readme.txt yang diperbarui ke server.

Fiuh. Itu saja!

Sudahkah Anda mengunggah plugin apa pun ke Direktori Plugin WordPress? Bagikan pengalaman dan komentar Anda di bawah.
Tag:
  • pengembang
  • wordpress.org