Boîte à outils du développeur WordPress intelligent GitHub Plugin Updater

Vous ne voulez pas héberger votre plugin dans le répertoire de plugins WordPress.org? Bien sûr, vous pouvez décider de ne pas le faire, c'est une communauté libre après tout. Mais vous devez l'héberger quelque part pour pouvoir trouver le plug-in, et vous devez également fournir à vos utilisateurs des mises à jour de votre plug-in.. 

La plupart des gens qui décident de ne pas héberger leurs plugins sur WordPress.org ont tendance à utiliser GitHub, mais WordPress ne sait pas comment mettre à jour les plugins hébergés par GitHub - il a besoin d'aide. Et aujourd'hui, nous allons vous aider à aider WordPress à mettre à jour vos plugins avec, vous l'avez deviné, une classe d'assistance.

Dans cette partie de la série "Boîte à outils de Smart WordPress Developer", nous allons passer en revue WordPress GitHub Plugin Updater, un outil permettant de gérer le processus de mise à jour des plugins WordPress hébergés sur GitHub..

Pourquoi utiliser GitHub au lieu de WordPress.org?

Comme tout système de gestion de contenu modulaire, WordPress dispose de son propre référentiel de plug-ins. Et je ne me serais pas trompé si je disais que le répertoire de plugins WordPress.org est devenu le standard de la communauté pour l'hébergement de plugins WordPress gratuits et à code source ouvert.

Mais comme je l'ai dit au début, c'est une communauté libre. WordPress ne nécessite pas que nous hébergions tous les plugins et thèmes que nous créons dans le répertoire de plugins WordPress.org. Les gens peuvent choisir de s'en éloigner, et c'est parfaitement naturel.

Le premier endroit où les gens hébergent leurs plugins WordPress après le répertoire de plugins WordPress.org est GitHub. En utilisant le système de contrôle de révision génial appelé Git, GitHub est l’un des meilleurs endroits pour partager votre logiciel open source avec le reste du monde. Et depuis quelques années, de plus en plus de développeurs WordPress publient leurs nouveaux plugins sur GitHub..

Avantages et inconvénients de passer du répertoire de plugins WordPress.org à GitHub

Je pense qu'il existe un équilibre entre les avantages et les inconvénients de l'hébergement de plugins WordPress sur GitHub au lieu du répertoire de plugins WordPress.org. Je vais exposer ceux qui me viennent à l’esprit, mais j’aimerais également votre avis, n'hésitez donc pas à enregistrer un commentaire dans la section Commentaires après avoir lu ceci..

Lorsque vous hébergez vos plugins sur WordPress.org:

• Vous devez utiliser SVN.
• Votre plugin doit être approuvé par un relecteur WordPress.org avant de pouvoir le télécharger. (Ceci est à la fois un avantage et un inconvénient pour moi, car avoir un deuxième regard sur le code est utile pour détecter les failles de sécurité.)
• Vous ne pouvez utiliser que la GPL (version 2 ou ultérieure) comme licence.
• Vos mises à jour de plugin seront notifiées à vos utilisateurs rapidement.
• Les mises à jour d'urgence des plugins (pour des raisons de sécurité) seront automatiquement transmises aux utilisateurs..
• Les gens peuvent trouver votre plugin directement à partir de leurs panneaux d’administration, ce qui est un énorme avantage.
• Vous pouvez utiliser les forums de support de WordPress.org.

Et quand vous décidez de passer à GitHub:

• Vous pourrez utiliser Git.
• Vous aurez infiniment plus de liberté.
• Vous pouvez utiliser d'autres types de licences (comme MIT ou CC, même si CC n'est pas recommandé pour les logiciels)..
• Vous pouvez créer un wiki, accepter des commits et parler de problèmes avec vos utilisateurs.
• Vous n'aurez aucune évaluation pour vos plugins, ce qui est mauvais pour les commentaires.
• Vous devrez terminer ce tutoriel afin de fournir plus facilement les mises à jour de plugins..

Il y a aussi un bon débat sur WordPress Tavern qui-je pense-vous devriez également lire.

Intégration du programme de mise à jour du plugin WordPress GitHub dans votre plugin

Prêt à fournir des notifications de mise à jour pour vos utilisateurs?

Tout d’abord, vous devez évidemment télécharger le programme de mise à jour WordPress GitHub Plugin Updater à partir de son référentiel GitHub. Vous aurez seulement besoin du updater.php fichier, alors ne vous inquiétez pas des autres.

Après cela, vous devez mettre le updater.php déposer quelque part dans votre dossier de plugin et l'inclure dans votre plugin. Par exemple, si vous mettez le updater.php fichier dans un dossier nommé github-plugin-updater et vous voulez l'inclure dans votre fichier de plugin principal, vous devez ajouter la ligne suivante à ce fichier:

Vous devez également initialiser le WP_GitHub_Updater classe avec les arguments corrects pour connecter votre plugin à votre dépôt GitHub:

 plugin_basename (__FILE__), 'proper_folder_name' => 'plugin-name', 'api_url' => 'https://api.github.com/repos/username/repository-name', 'raw_url' => 'https: / /raw.github.com/username/repository-name/master ',' github_url '=>' https://github.com/username/repository-name ',' zip_url '=>' https://github.com / username / repository-name / zipball / master ',' sslverify '=> true,' require '=>' 3.0 ',' test '=>' 3.3 ',' readme '=>' README.md ',' access_token '=> "); new WP_GitHub_Updater ($ config);?>

• limace: Le slug de votre plugin.
• nom_folder_propre: Le nom du dossier de votre plugin.
• api_url: URL de l'API de votre dépôt GitHub.
• raw_url: L'URL brute de votre dépôt GitHub.
• github_url: L'URL de votre dépôt GitHub.
• zip_url: L'URL ZIP de votre dépôt GitHub.
• sslverify: Que ce soit pour vérifier SSL ou non.
• a besoin: La version minimale de WordPress requise par votre plugin.
• testé: La version maximale de WordPress avec laquelle vous avez testé votre plugin.
• readme (obsolète): Le fichier README permettant de vérifier la version du plugin depuis.
• jeton d'accès: Votre jeton d'accès GitHub, si vous utilisez un dépôt privé.

Pour informer vos utilisateurs, il vous suffit de changer la version du plug-in dans les en-têtes de votre fichier principal. (Il semble que cet outil ait utilisé le fichier README pour rechercher une ligne contenant ~ Version actuelle: X.X ~ mais à partir de la version 1.6, il cherche d’abord le fichier du plugin principal.)

Et c'est tout! Suivez ces étapes pour activer les notifications de mise à jour pour votre plugin..

Envelopper pour aujourd'hui

Si vous souhaitez héberger votre plugin WordPress sur GitHub et que vous souhaitez fournir des notifications de mise à jour à vos utilisateurs, WordPress GitHub Plugin Updater est l'un des outils essentiels que vous devriez utiliser..

Que pensez-vous de cet outil ou de l'hébergement de plugins WordPress sur GitHub en général? Partagez vos opinions avec nous en commentant dans la section Commentaires ci-dessous. Et si vous avez aimé l'article, n'oubliez pas de le partager avec vos amis!