Come pubblicare il vostro primo plugin nel repository ufficiale di WordPress

Visto che mi sono cimen­tato nella rea­liz­za­zione del mio primo plu­gin per Word­Press ritengo utile con­di­vi­dere con voi que­sta mini guida (che mi è stata utile) su come pub­bli­care il vostro plu­gin nel repo­si­tory ufficiale.

Quanto segue è una sem­plice e libera tra­du­zione di
un tuto­rial in lin­gua inglese di Tom McFar­lin
com­parso su: http://wp.tutsplus.com

Una delle con­si­de­ra­zioni che tutti gli svi­lup­pa­tori di plu­gin Word­Press dovreb­bero fare è come pub­bli­care il pro­prio lavoro. Molti plu­gin a paga­mento pre­di­li­gono uti­liz­zare il pro­prio sito web per gestire il plu­gin, la docu­men­ta­zione e l’acquisto, ma se hai inten­zione di pub­bli­care un plu­gin gra­tuito o una ver­sione ridotta di un plu­gin a paga­mento, allora uti­liz­zare il repo­si­tory dei plu­gin di Word­Press è senz’altro un’ottima idea.

WordPress.org offre source con­trol, sta­ti­sti­che, e noti­fica auto­ma­ti­ca­mente agli utenti di un avve­nuto aggior­na­mento gra­tui­ta­mente. Di certo non è un male sfrut­tare l’elevato ran­king del sito nei motori di ricerca, il vostro plu­gin ne beneficerà!

In quest’articolo vedremo come con­fi­gu­rare un repo­si­tory per un plu­gin Word­Press e man­te­nere il vostro pro­getto durante il ciclo di svi­luppo. Notate che in que­sto arti­colo si pre­sume che abbiate un minimo di fami­lia­rità con i con­cetti base di Subversion.


Fase 1: Richie­dere l’accesso

Prima di richie­dere l’accesso al repo­si­tory per il vostro pro­getto, avete biso­gno di creare un account su WordPress.org. Tutto que­sto è gra­tuito e semplice.

Per prima cosa andate su que­sta pagina ed inse­rite le infor­ma­zioni richie­ste. Una volta che il vostro account sarà con­fer­mato potrete ini­ziare a con­fi­gu­rare il repo­si­tory. Andate nel Word­Press Deve­lo­per Cen­ter. Dalla home­page di WordPress.org, fate click su Extend and Plu­gins. Suc­ces­si­va­mente, fate click su “Add Your Plugin:”

Nella scher­mata suc­ces­siva vi verrà richie­sto di inse­rire il nome del vostro plu­gin, una breve descri­zione e l’URL dell’hompage del pro­getto. Non c’è biso­gno andare troppo a fondo, ma ecco qui alcuni sem­plici sug­ge­ri­menti che ser­vi­ranno per la richiesta:

  • Assi­cu­ra­tevi che il nome del plu­gin sia quello defi­ni­tivo. Una volta otte­nuto l’accesso al repo­si­tory, non potrai cam­biarne il nome. Pen­sate quindi stra­te­gi­ca­mente al nome del plu­gin. Per migliori risul­tati è pre­fe­ri­bile sce­gliere un nome sem­plice stret­ta­mente legato a ciò che gli utenti potreb­bero cer­care nei motori di ricerca.
  • Non spre­cate troppo tempo a riflet­tere sulla descri­zione in que­sta fase. Va benis­simo una descri­zione sin­te­tica, anche una sola frase. Il file README del vostro plu­gin for­nirà una descri­zione più det­ta­gliata una volta che avrete pub­bli­cato il vostro pro­getto.
  • L’URL all’homepage del vostro plu­gin non deve essere neces­sa­ria­mente quello defi­ni­tivo, ma assi­cu­ra­tevi che qua­lun­que URL spe­ci­fi­chiate sia dove attual­mente è repe­ri­bile il plugin.

Una volta che avrete for­nito le infor­ma­zioni, inviate la richie­sta. Rice­ve­rete un’email con le cre­den­ziali di accesso al vostro repo­si­tory gene­ral­mente tra le 24 e le 48 ore dopo aver ese­guito la richiesta.


Fase 2:  Con­fi­gu­rare il Repository

Una volta rice­vuto l’URL del repo­si­tory, potrete ese­guire il chec­kout ini­ziale. Uti­liz­zando il vostro client sub­ver­tion pre­fe­rito (l’autore dell’articolo ori­gi­nale ha uti­liz­zato Tor­toi­se­SVN in que­sto tuto­rial), ese­guite il chec­kout uti­liz­zando l’URL del repo­si­toty che vi è stato asse­gnato:

Ciò creerà una direc­tory con il nome del plu­gin che avete spe­ci­fi­cato nella prima fase di que­sto tuto­rial, inol­tre ini­zia­liz­zerà le direc­tory bran­ches, tags, e trunk:

Una pic­cola nota sulla strut­tura delle directory:

  • La direc­tory trunk del repo­si­tory è la car­tella di lavoro prin­ci­pale in cui ese­gui­rete la mag­gior parte dello sviluppo.
  • La car­tella tags include ver­sioni, o snap­shots del trunk ad un certo istante del ciclo di svi­luppo. Alcune volte potre­ste tag­gare il trunk ogni volta che vor­rete rila­sciare una nuova release.
  • La car­tella branch è una copia del trunk ad un certo istante che verrà uti­liz­zato per pic­coli svi­luppi. Se state per rea­liz­zare grosse modi­fi­che, è meglio ese­guire un branch – in que­sto modo pre­ser­ve­rete la qua­lità del lavoro del trunk.

Potete leg­gere di più sulla strut­tura di direc­tory di sub­ver­sion qui.


Fase 4: Ese­guire il Com­mit dei cambiamenti

A que­sto punto, potete ini­ziare a lavo­rare sul repo­si­tory. Se que­sta è la prima volta che ci lavo­rate, la vostra direc­tory trunk dovrebbe essere vuota. Se già avete ini­ziato a lavo­rare sul plu­gin prima di ini­zia­liz­zare la direc­tory, allora copiate ora i file nella direc­tory trunk, altri­menti ini­ziate pure a lavo­rare sul plugin.

Una volta che avrete copiato i file o avrete ini­ziato a lavo­rare al plu­gin, avrete biso­gno di aggiun­gere i file al source con­trol. Per farlo ese­guite il comando add:

Que­sta ope­ra­zione dirà a sub­ver­sion di ini­ziare a tener trac­cia dei file. Subito dopo ese­guite il comando commit:

A que­sto punto avrete inviato il codice di base del vostro plu­gin al repo­si­tory di WordPress.

Chia­ra­mente il vostro plu­gin non sarà ancora pub­bli­cato fin­chè non avrete asse­gnato i tag. Prima di far que­sto però assi­cu­ra­tevi di aver con­fi­gu­rato cor­ret­ta­mente l’hea­der ed il file README del vostro plu­gin. Potete leg­gere anche gli arti­coli della serie Wri­ting Main­tai­na­ble Word­Press Wid­gets.


Fase 3: Asse­gnare i Tag ed effet­tuare la Release

Sup­po­nendo che abbiate rea­liz­zato una ver­sione com­pleta del vostro plu­gin e anniate con­fi­gu­rato l’header e il file README, è giunto il momento di rila­sciare la prima ver­sione del vostro plu­gin. Per farlo ese­guite il comando Branch/Tag sulla direc­tory trunk.

Prima di fare que­sto assi­cu­ra­tevi di aver aggior­nato il ver­sion tag nell’header del plugin:

e di aver aggior­nato lo Sta­ble tag del file README:

Ora ese­guite il com­mit dei dei cam­bia­menti al trunk.

Fatto que­sto siete pronti per aggiun­gere i tag:

A que­sto punto Sub­ver­sion vi chie­derà quale car­tella volete uti­liz­zare. E’ molto impor­tante accer­tarsi di aver impo­stato cor­ret­ta­mente la car­tella del plu­gin. Molti client Sub­ver­sion infatti uti­liz­zano come desti­na­zione la car­tella trunk. Que­sto è sba­gliato – invece dovre­ste cam­biare la desti­na­zione in /tags/1.0 (ma se state tag­gando la ver­sione 1.5 o 2.0 dovrete cam­biare il numero):

Ora final­mente il vostro plu­gin è stato regi­strato nel source con­trol ed è stato tag­gato ad una ver­sione spe­ci­fica. Entro 20 minuti il vostro plu­gin dovrebbe appa­rire nel repo­si­tory dei plu­gin  Word­Press all’URL che vi è stato asse­gnato alla vostra richie­sta di accesso al repository.

Comments are closed.