Come pubblicare il vostro primo plugin nel repository ufficiale di WordPress

Visto che mi sono cimentato nella realizzazione del mio primo plugin per WordPress ritengo utile condividere con voi questa mini guida (che mi è stata utile) su come pubblicare il vostro plugin nel repository ufficiale.

[quote style=”1″]Quanto segue è una semplice e libera traduzione di
un tutorial in lingua inglese di Tom McFarlin
comparso su: http://wp.tutsplus.com
[/quote]

Una delle considerazioni che tutti gli sviluppatori di plugin WordPress dovrebbero fare è come pubblicare il proprio lavoro. Molti plugin a pagamento prediligono utilizzare il proprio sito web per gestire il plugin, la documentazione e l’acquisto, ma se hai intenzione di pubblicare un plugin gratuito o una versione ridotta di un plugin a pagamento, allora utilizzare il repository dei plugin di WordPress è senz’altro un’ottima idea.

WordPress.org offre source control, statistiche, e notifica automaticamente agli utenti di un avvenuto aggiornamento gratuitamente. Di certo non è un male sfruttare l’elevato ranking del sito nei motori di ricerca, il vostro plugin ne beneficerà!

In quest’articolo vedremo come configurare un repository per un plugin WordPress e mantenere il vostro progetto durante il ciclo di sviluppo. Notate che in questo articolo si presume che abbiate un minimo di familiarità con i concetti base di Subversion.


Fase 1: Richiedere l’accesso

Prima di richiedere l’accesso al repository per il vostro progetto, avete bisogno di creare un account su WordPress.org. Tutto questo è gratuito e semplice.

Per prima cosa andate su questa pagina ed inserite le informazioni richieste. Una volta che il vostro account sarà confermato potrete iniziare a configurare il repository. Andate nel WordPress Developer Center. Dalla homepage di WordPress.org, fate click su Extend and Plugins. Successivamente, fate click su “Add Your Plugin:”

Nella schermata successiva vi verrà richiesto di inserire il nome del vostro plugin, una breve descrizione e l’URL dell’hompage del progetto. Non c’è bisogno andare troppo a fondo, ma ecco qui alcuni semplici suggerimenti che serviranno per la richiesta:

  • Assicuratevi che il nome del plugin sia quello definitivo. Una volta ottenuto l’accesso al repository, non potrai cambiarne il nome. Pensate quindi strategicamente al nome del plugin. Per migliori risultati è preferibile scegliere un nome semplice strettamente legato a ciò che gli utenti potrebbero cercare nei motori di ricerca.
  • Non sprecate troppo tempo a riflettere sulla descrizione in questa fase. Va benissimo una descrizione sintetica, anche una sola frase. Il file README del vostro plugin fornirà una descrizione più dettagliata una volta che avrete pubblicato il vostro progetto.
  • L’URL all’homepage del vostro plugin non deve essere necessariamente quello definitivo, ma assicuratevi che qualunque URL specifichiate sia dove attualmente è reperibile il plugin.

Una volta che avrete fornito le informazioni, inviate la richiesta. Riceverete un’email con le credenziali di accesso al vostro repository generalmente tra le 24 e le 48 ore dopo aver eseguito la richiesta.


Fase 2:  Configurare il Repository

Una volta ricevuto l’URL del repository, potrete eseguire il checkout iniziale. Utilizzando il vostro client subvertion preferito (l’autore dell’articolo originale ha utilizzato TortoiseSVN in questo tutorial), eseguite il checkout utilizzando l’URL del repositoty che vi è stato assegnato:

Ciò creerà una directory con il nome del plugin che avete specificato nella prima fase di questo tutorial, inoltre inizializzerà le directory branches, tags, e trunk:

Una piccola nota sulla struttura delle directory:

  • La directory trunk del repository è la cartella di lavoro principale in cui eseguirete la maggior parte dello sviluppo.
  • La cartella tags include versioni, o snapshots del trunk ad un certo istante del ciclo di sviluppo. Alcune volte potreste taggare il trunk ogni volta che vorrete rilasciare una nuova release.
  • La cartella branch è una copia del trunk ad un certo istante che verrà utilizzato per piccoli sviluppi. Se state per realizzare grosse modifiche, è meglio eseguire un branch – in questo modo preserverete la qualità del lavoro del trunk.

Potete leggere di più sulla struttura di directory di subversion qui.


Fase 4: Eseguire il Commit dei cambiamenti

A questo punto, potete iniziare a lavorare sul repository. Se questa è la prima volta che ci lavorate, la vostra directory trunk dovrebbe essere vuota. Se già avete iniziato a lavorare sul plugin prima di inizializzare la directory, allora copiate ora i file nella directory trunk, altrimenti iniziate pure a lavorare sul plugin.

Una volta che avrete copiato i file o avrete iniziato a lavorare al plugin, avrete bisogno di aggiungere i file al source control. Per farlo eseguite il comando add:

Questa operazione dirà a subversion di iniziare a tener traccia dei file. Subito dopo eseguite il comando commit:

A questo punto avrete inviato il codice di base del vostro plugin al repository di WordPress.

Chiaramente il vostro plugin non sarà ancora pubblicato finchè non avrete assegnato i tag. Prima di far questo però assicuratevi di aver configurato correttamente l’header ed il file README del vostro plugin. Potete leggere anche gli articoli della serie Writing Maintainable WordPress Widgets.


Fase 3: Assegnare i Tag ed effettuare la Release

Supponendo che abbiate realizzato una versione completa del vostro plugin e anniate configurato l’header e il file README, è giunto il momento di rilasciare la prima versione del vostro plugin. Per farlo eseguite il comando Branch/Tag sulla directory trunk.

Prima di fare questo assicuratevi di aver aggiornato il version tag nell’header del plugin:

e di aver aggiornato lo Stable tag del file README:

Ora eseguite il commit dei dei cambiamenti al trunk.

Fatto questo siete pronti per aggiungere i tag:

A questo punto Subversion vi chiederà quale cartella volete utilizzare. E’ molto importante accertarsi di aver impostato correttamente la cartella del plugin. Molti client Subversion infatti utilizzano come destinazione la cartella trunk. Questo è sbagliato – invece dovreste cambiare la destinazione in /tags/1.0 (ma se state taggando la versione 1.5 o 2.0 dovrete cambiare il numero):

Ora finalmente il vostro plugin è stato registrato nel source control ed è stato taggato ad una versione specifica. Entro 20 minuti il vostro plugin dovrebbe apparire nel repository dei plugin  WordPress all’URL che vi è stato assegnato alla vostra richiesta di accesso al repository.

Comments are closed.