Utilizarea Subversion cu directorul de pluginuri WordPress

Publicat: 2012-07-24

Urmați aceste instrucțiuni pas cu pas pentru a adăuga și actualiza pluginuri în directorul public de pluginuri WordPress.

Acești pași esențiali din videoclip urmează mai jos:

  • Noțiuni introductive cu pluginul dvs
  • Înregistrați-vă pentru un cont WordPress.org
  • Solicitați introducerea noului dvs. plugin în directorul de pluginuri WordPress
  • Instalați un client SVN pentru mașina dvs
  • Alegeți un director local pentru proiectele dvs
  • E-mailul de aprobare al solicitării pluginului dvs
  • Termenii directorului pentru acest articol
  • Tragerea noului director de server la mașina dvs. locală
  • Finalizați dezvoltarea pluginului dvs
  • Faceți prima versiune disponibilă publicului
    • Actualizarea trunchiului directorului de proiect
    • Etichetarea unei versiuni noi pe server
    • Actualizarea directorului local de proiect cu noua versiune etichetată
    • Se actualizează eticheta stabilă readme.txt
  • Noi dezvoltări pentru pluginul dvs

Noțiuni introductive cu pluginul dvs

Indiferent dacă aveți doar o idee sau ați terminat cu versiunea 0.1, aveți nevoie de un nume și de o descriere pentru pluginul dvs. Faceți numele scurt și descriptiv, dând o idee despre ce face pluginul. „Wax on Wax off Plugin” nu este un nume bun. „Drop Shadow Maker” este mult mai bun. Nu trebuie să adăugați „Plugin” la titlul real.

Pentru a merge împreună cu titlul dvs., ar trebui să scrieți o scurtă descriere care să le spună oamenilor ce beneficii oferă pluginul dvs. Recomand ca aceasta descriere sa fie sub 150 de caractere.

Înregistrați-vă pentru un cont WordPress.org

Dacă nu aveți deja un cont WordPress.org – folosit pentru a interacționa în forumurile de asistență și altele asemenea – trebuie să obțineți unul. Pur și simplu accesați: https://login.wordpress.org/register

Solicitați introducerea noului dvs. plugin în directorul de pluginuri WordPress

Majoritatea pluginurilor rezonabile livrate cu o licență compatibilă pot obține spațiu în Directorul de pluginuri WordPress.

  1. Accesați: http://wordpress.org/extend/plugins/add/
  2. Completați titlul și descrierea dvs
    (Ți-am spus că vei avea nevoie de asta!)
  3. Omiteți încărcarea pluginului dvs. din acest formular, chiar dacă pluginul dvs. este gata de funcționare.

Solicitarea dvs. de director de plugin este procesată de oameni reali, așa că ar putea dura ceva timp.

Instalați un client SVN pentru mașina dvs

Pentru a lucra cu Plugin Directory, aveți nevoie de un client Subversion pe computer.

  • Pentru Windows, recomand TortoiseSVN.
  • Pentru Mac, se pare că SCPlugin este un pachet bun.

Doar alegeți unul și instalați-l. Nu sunt multe de spus despre asta.

Alegeți un director local pentru proiectele dvs

Subversion va păstra actualizată o copie locală a fișierelor dvs. de plugin cu directorul de pluginuri WordPress. Vă recomand să creați un director pe mașina dvs. locală, unde veți păstra toate proiectele urmărite de Subversion. Atenție: Dacă aveți un mediu de dezvoltare web pe mașina dvs. locală, nu fi tentat să utilizați directorul de pluginuri WordPress al serverului web local ca director de proiect.

De exemplu, dacă aveți o instalare WordPress locală pe mașina dvs. unde se află folderul de pluginuri:

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

… nu credeți că puteți utiliza acel director pentru a sincroniza proiectele dvs. WordPress Plugin Directory. Asta vă va provoca durere.

În schimb, creați un director ca acest exemplu:

documents/projects/wp-plugins-public/

Fiecare dintre folderele proiectelor dvs. de plugin vor intra în „wp-plugins-public”. Pentru acest tutorial, voi folosi un folder de plugin numit „content-scheduler”. Deci, voi fi făcut un director ca atare:

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

E-mailul de aprobare al solicitării pluginului dvs

Odată ce solicitarea dvs. de plugin a fost aprobată, veți primi un e-mail cu un link către depozitul dvs. SVN. Acesta este special pentru acel plugin și este necesar pentru a continua cu sincronizarea Subversion.

Termenii directorului pentru acest articol

Cu atât de multe directoare, proiecte și foldere diferite menționate în acest articol, ar putea fi ușor să fii confuz. Să cădem de acord asupra a trei locații diferite atunci când lucrăm cu acest flux de lucru Subversion.

  1. Director de lucru
    Aceasta este copia curentă a codului pe care îl modificați și pe care îl testați. Ar trebui să fie în folderul „/wp-content/plugins/” de pe serverul web de dezvoltare. Pe aparatul meu, se întâmplă să fie:
    documents/public_html/devdomain.com/wp-content/plugins/content-scheduler/
  2. Directorul de proiecte
    Acesta este directorul pe care clientul dvs. Subversion îl va păstra sincronizat cu Directorul de pluginuri WordPress. Pe mașina mea, acesta este:
    documents/projects/wp-plugins-public/content-scheduler/
  3. Directorul serverului
    Aceasta se referă la proiectul dvs. așa cum este stocat în Directorul de pluginuri WordPress. Aici publicul va putea obține pluginul dvs. Locația rădăcină se numește „depozitul SVN” și îți va fi atribuită în e-mailul de aprobare a solicitării pluginului. Pentru exemplul meu, acesta este:
    http://plugins.svn.wordpress.org/content-scheduler

Tragerea noului director de server la mașina dvs. locală

Chiar dacă nu ați introdus niciun fișier în noua locație a pluginului în Directorul de pluginuri, trebuie să trageți în jos acea copie a directorului pe computer. Procedând astfel, se stabilesc câteva semnale în culise pentru a ajuta clientul dvs. Subversion să știe ce este actualizat și ce nu.

  1. Faceți clic dreapta pe folderul plugin directorul proiectului.
  2. Alegeți „SVN Checkout”.
  3. Introduceți adresa URL a depozitului SVN WordPress (din e-mailul de aprobare) în primul câmp.
  4. Dosarul de plugin al directorului de proiect ar trebui să fie în al doilea câmp.
    Deoarece ați început acest proces făcând clic dreapta pe acel dosar, acest câmp ar trebui să fie deja completat.
  5. Faceți clic pe „OK”

Finalizați dezvoltarea pluginului dvs

Dezvoltați și testați-vă pluginul. Aceasta include crearea unui fișier „readme.txt” adecvat, care să fie însoțit de acesta. Fișierul „readme.txt” nu este doar câteva note aleatorii despre pluginul tău. Directorul de pluginuri WordPress folosește conținutul fișierului „readme.txt” pentru a înțelege ce versiune a pluginului dvs. este considerată actuală și, de asemenea, pentru a construi conținutul paginii pluginului dvs. în Director.

  • Pentru mai multe informații despre crearea unui fișier „readme.txt” adecvat, consultați acest exemplu WordPress readme.txt.

O parte esențială a fișierului „readme.txt” este eticheta „Stable”. În timp ce vă dezvoltați pluginul, lăsați această etichetă pe „trunk”. Odată ce lansați o versiune pentru consumul public, o vom actualiza cu numărul corect al versiunii.

Faceți prima versiune disponibilă publicului

Actualizarea trunchiului directorului de proiect

  1. Copiați conținutul directorului de lucru în folderul „trunk” al directorului de proiect.
    În cazul meu, copiez întregul conținut al pluginului meu din directorul de lucru:
    /documents/public_html/devdomain.com/wp-content/plugins/content-scheduler/
    în directorul meu de proiecte:
    /documents/projects/wp-plugins-public/content-scheduler/
  2. Faceți clic dreapta pe folderul plugin „content-scheduler” din directorul proiectului și alegeți „SVN Commit”.
  3. Introduceți un comentariu pentru commit dacă doriți.
  4. Examinați lista de fișiere care sunt considerate noi și care vor fi copiate pe server. Dacă această listă pare corectă, faceți clic pe „OK” și fișierele vor fi copiate în directorul serverului dvs. la wordpress.org.

Etichetarea unei versiuni noi pe server

Ați actualizat fișierele în „trunk”, dar acest lucru nu este ceea ce publicul ar trebui să descarce. Trebuie să utilizați „etichetarea” pentru a crea o copie a „trunchiului”. Această copie nu va mai fi modificată și va fi oferită uzului public. Pentru acest exemplu, să creăm o versiune 1.0.

  1. Faceți clic dreapta pe folderul „trunk” al directorului proiectului și alegeți „Branch/Tag”.
    Pentru mine, acesta este:
    /documents/projects/wp-plugins-public/content-scheduler/trunk/
  2. Câmpul de locație „Către URL” se va termina cu „/trunk”. Trebuie să schimbați acest lucru în „/tags/1.0” pentru a vă crea versiunea 1.0.
  3. Dacă doriți, puteți adăuga o notă despre această operațiune de etichetare.
  4. Faceți clic pe „OK” și ignorați orice mesaj despre „important să treceți la această ramură...”

Actualizarea directorului local de proiect cu noua versiune etichetată

Tocmai ați spus serverului să facă o nouă copie a fișierelor de proiect în directorul „/tags/1.0”. Acum, trebuie să actualizăm directorul local de proiecte cu acea nouă etichetă.

Acest proces poate părea ciudat. S-ar putea să vă întrebați de ce nu vă puteți face propria copie în directorul local „/tags/1.0”. Dacă faceți asta, directorul serverului și directorul de proiect pot deveni dezordonate și confuze în ceea ce privește ce este actualizat și ce nu.

  • Faceți clic dreapta pe directorul proiectului din nou și alegeți „Actualizare SVN”.
    Aceasta aduce modificări din directorul serverului în directorul local al proiectului. În acest caz, modificarea este o adăugare a copiei „/tags/1.0” a fișierelor dvs.

Se actualizează eticheta stabilă readme.txt

Toate fișierele potrivite sunt disponibile pentru ca publicul să vă folosească pluginul. Cu toate acestea, trebuie să spunem directorului de pluginuri ce versiune etichetată ar trebui să folosească publicul.

  1. Editați fișierul „readme.txt” în folderul „trunk” al directorului local al proiectului.
    Pentru mine, acesta este următorul:
    /documents/projects/wp-plugins-public/content/scheduler/trunk/readme.txt
  2. Schimbați „eticheta stabilă” la versiunea dvs. de lansare, „1.0”
  3. Salvați fișierul
  4. Faceți clic dreapta pe fișierul „readme.txt” pe care tocmai l-ați actualizat și alegeți „SVN Commit”.

Asta e! În aproximativ 15 minute:

  1. Directorul de pluginuri WordPress va actualiza lista de proiecte
  2. „1.0” va fi văzut ca etichetă stabilă
  3. Informațiile din „/tags/1.0/readme.txt” vor fi folosite pentru a completa pagina proiectului.

Noi dezvoltări pentru pluginul dvs

Cel mai probabil, veți aduce îmbunătățiri pluginului și va trebui să le publicați. Iată cum funcționează.

  1. Efectuați modificări la pluginul din directorul dvs. de lucru.
    Aceste modificări ar trebui să includă modificări ale fișierului readme.txt după cum este necesar, cum ar fi intrările din Jurnalul de modificări.
  2. Copiați modificările din directorul de lucru în directorul local de proiect.
  3. Asigurați-vă că fișierul readme.txt are eticheta „stabilă” corectă pentru versiunea publică curentă.
  4. Faceți clic dreapta pe directorul proiectului și alegeți „SVN Commit” pentru a introduce noile modificări ale trunchiului în directorul serverului.
  5. Faceți clic dreapta pe directorul „trunk” din directorul proiectului și alegeți „Branch/Tag” pentru a crea o nouă etichetă de versiune pentru lansare. (Asigurați-vă că „Creați o copie în depozit din:” este setat la „Copie de lucru.”)
  6. Faceți clic dreapta pe directorul proiectului și alegeți „Actualizare SVN” pentru a derula modificările etichetelor din directorul serverului.
  7. Actualizați eticheta stabilă din fișierul „/trunk/readme.txt” din directorul proiectului pentru a se potrivi cu noua etichetă de lansare pe care ați creat-o.
  8. Faceți clic dreapta pe directorul proiectului (da, încă o dată) și alegeți „SVN Commit” pentru a trimite fișierul actualizat readme.txt pe server.

Uf. Asta e tot!

Ați încărcat pluginuri în directorul de pluginuri WordPress? Împărtășește-ți experiența și comentariile mai jos.
Etichete:
  • dezvoltatori
  • wordpress.org