Come pubblicare il vostro primo plugin nel repository ufficiale di WordPress

Come pubblicare il vostro primo plugin nel repository ufficiale di WordPress

Visto che mi sono cimen­tato nella real­iz­zazione del mio primo plu­gin per Word­Press ritengo utile con­di­videre con voi questa mini guida (che mi è stata utile) su come pub­bli­care il vostro plu­gin nel repos­i­tory ufficiale.

[gn_quote style=”1″]Quanto segue è una sem­plice e lib­era traduzione di un tuto­r­ial in lin­gua inglese di Tom McFar­lin com­parso su: http://wp.tutsplus.com[/gn_quote]

Una delle con­sid­er­azioni che tutti gli svilup­pa­tori di plu­gin Word­Press dovreb­bero fare è come pub­bli­care il pro­prio lavoro. Molti plu­gin a paga­mento prediligono uti­liz­zare il pro­prio sito web per gestire il plu­gin, la doc­u­men­tazione e l’acquisto, ma se hai inten­zione di pub­bli­care un plu­gin gra­tu­ito o una ver­sione ridotta di un plu­gin a paga­mento, allora uti­liz­zare il repos­i­tory dei plu­gin di Word­Press è senz’altro un’ottima idea.

WordPress.org offre source con­trol, sta­tis­tiche, e noti­fica auto­mati­ca­mente agli utenti di un avvenuto aggior­na­mento gra­tuita­mente. Di certo non è un male sfruttare l’elevato rank­ing del sito nei motori di ricerca, il vostro plu­gin ne beneficerà!

In quest’articolo vedremo come con­fig­u­rare un repos­i­tory per un plu­gin Word­Press e man­tenere il vostro prog­etto durante il ciclo di sviluppo. Notate che in questo arti­colo si pre­sume che abbi­ate un min­imo di famil­iar­ità con i con­cetti base di Subversion.

Fase 1: Richiedere l’accesso

Prima di richiedere l’accesso al repos­i­tory per il vostro prog­etto, avete bisogno di creare un account su WordPress.org. Tutto questo è gra­tu­ito e semplice.

Per prima cosa andate su questa pag­ina ed inserite le infor­mazioni richi­este. Una volta che il vostro account sarà con­fer­mato potrete iniziare a con­fig­u­rare il repos­i­tory. Andate nel Word­Press Devel­oper Cen­ter. Dalla home­page di WordPress.org, fate click su Extend and Plu­g­ins. Suc­ces­si­va­mente, fate click su “Add Your Plugin:”

Nella scher­mata suc­ces­siva vi verrà richiesto di inserire il nome del vostro plu­gin, una breve descrizione e l’URL dell’hompage del prog­etto. Non c’è bisogno andare troppo a fondo, ma ecco qui alcuni sem­plici sug­ger­i­menti che servi­ranno per la richiesta:

  • Assi­cu­rat­evi che il nome del plu­gin sia quello defin­i­tivo. Una volta ottenuto l’accesso al repos­i­tory, non potrai cam­biarne il nome. Pen­sate quindi strate­gi­ca­mente al nome del plu­gin. Per migliori risul­tati è preferi­bile scegliere 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 descrizione in questa fase. Va benis­simo una descrizione sin­tet­ica, anche una sola frase. Il file README del vostro plu­gin fornirà una descrizione più det­tagli­ata una volta che avrete pub­bli­cato il vostro prog­etto.
  • L’URL all’homepage del vostro plu­gin non deve essere nec­es­sari­a­mente quello defin­i­tivo, ma assi­cu­rat­evi che qualunque URL speci­fichi­ate sia dove attual­mente è reperi­bile il plugin.

Una volta che avrete for­nito le infor­mazioni, invi­ate la richi­esta. Ricev­erete un’email con le cre­den­ziali di accesso al vostro repos­i­tory gen­eral­mente tra le 24 e le 48 ore dopo aver ese­guito la richiesta.

Fase 2:  Con­fig­u­rare il Repository

Una volta rice­vuto l’URL del repos­i­tory, potrete eseguire il check­out iniziale. Uti­liz­zando il vostro client sub­ver­tion prefer­ito (l’autore dell’articolo orig­i­nale ha uti­liz­zato Tor­tois­eSVN in questo tuto­r­ial), ese­guite il check­out uti­liz­zando l’URL del repos­i­toty che vi è stato asseg­nato:

Ciò creerà una direc­tory con il nome del plu­gin che avete spec­i­fi­cato nella prima fase di questo tuto­r­ial, inoltre inizial­izzerà le direc­tory branches, tags, e trunk:

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

  • La direc­tory trunk del repos­i­tory è la cartella di lavoro prin­ci­pale in cui eseguirete la mag­gior parte dello sviluppo.
  • La cartella tags include ver­sioni, o snap­shots del trunk ad un certo istante del ciclo di sviluppo. Alcune volte potreste tag­gare il trunk ogni volta che vor­rete rilas­ciare una nuova release.
  • La cartella branch è una copia del trunk ad un certo istante che verrà uti­liz­zato per pic­coli sviluppi. Se state per real­iz­zare grosse mod­i­fiche, è meglio eseguire un branch – in questo modo pre­serverete la qual­ità del lavoro del trunk.

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

Fase 4: Eseguire il Com­mit dei cambiamenti

A questo punto, potete iniziare a lavo­rare sul repos­i­tory. Se questa è la prima volta che ci lavo­rate, la vos­tra direc­tory trunk dovrebbe essere vuota. Se già avete iniziato a lavo­rare sul plu­gin prima di inizial­iz­zare la direc­tory, allora copi­ate ora i file nella direc­tory trunk, altri­menti iniziate pure a lavo­rare sul plugin.

Una volta che avrete copi­ato i file o avrete iniziato a lavo­rare al plu­gin, avrete bisogno di aggiun­gere i file al source con­trol. Per farlo ese­guite il comando add:

Questa oper­azione dirà a sub­ver­sion di iniziare a tener trac­cia dei file. Subito dopo ese­guite il comando commit:

A questo punto avrete invi­ato il codice di base del vostro plu­gin al repos­i­tory di WordPress.

Chiara­mente il vostro plu­gin non sarà ancora pub­bli­cato finchè non avrete asseg­nato i tag. Prima di far questo però assi­cu­rat­evi di aver con­fig­u­rato cor­ret­ta­mente l’header ed il file README del vostro plu­gin. Potete leg­gere anche gli arti­coli della serie Writ­ing Main­tain­able Word­Press Wid­gets.

Fase 3: Asseg­nare i Tag ed effet­tuare la Release

Sup­po­nendo che abbi­ate real­iz­zato una ver­sione com­pleta del vostro plu­gin e anni­ate con­fig­u­rato l’header e il file README, è giunto il momento di rilas­ciare la prima ver­sione del vostro plu­gin. Per farlo ese­guite il comando Branch/Tag sulla direc­tory trunk.

Prima di fare questo assi­cu­rat­evi 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­bi­a­menti al trunk.

Fatto questo siete pronti per aggiun­gere i tag:

A questo punto Sub­ver­sion vi chiederà quale cartella volete uti­liz­zare. E’ molto impor­tante accer­tarsi di aver impostato cor­ret­ta­mente la cartella del plu­gin. Molti client Sub­ver­sion infatti uti­liz­zano come des­ti­nazione la cartella trunk. Questo è sbagliato – invece dovreste cam­biare la des­ti­nazione 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 reg­is­trato nel source con­trol ed è stato tag­gato ad una ver­sione speci­fica. Entro 20 minuti il vostro plu­gin dovrebbe apparire nel repos­i­tory dei plu­gin  Word­Press all’URL che vi è stato asseg­nato alla vos­tra richi­esta di accesso al repository.

Lascia un commento

Il tuo indirizzo email non sarà pubblicato. I campi obbligatori sono contrassegnati *