Verktygslåda för utvecklaren för Smart WordPress GitHub Plugin Updater

Vill du inte vara värd för din plugin i WordPress.org Plugin Directory? Självklart kan du bestämma dig för att inte-det är ju ett fritt samhälle trots allt. Men du måste vara värd någonstans så plugin kan hittas, och du bör också ge dina användare uppdateringar till ditt plugin. 

De flesta som väljer att inte vara värd för sina plugins på WordPress.org brukar använda GitHub, men WordPress vet inte hur man uppdaterar GitHub-hostade plugins. Det behöver hjälp. Och idag hjälper vi dig att hjälpa WordPress uppdatera dina plugins med, gissade du det, en hjälparklass.

I denna del av "Verktygslådan i Smart WordPress Developer" -serien kommer vi att gå igenom WordPress GitHub Plugin Updater, ett verktyg för att hantera uppdateringsprocessen för WordPress-plugins hostade på GitHub.

Varför använd GitHub istället för WordPress.org?

Precis som alla andra modulhanteringssystem har WordPress sin egen plugin-arkiv. Och jag skulle inte ha fel om jag sa att WordPress.org Plugin Directory har blivit gemenskapsstandard för hosting gratis och open source WordPress plugins.

Men som jag sa i början är detta ett fritt samhälle. WordPress kräver inte att vi är värd för alla plugin och tema som vi gör i WordPress.org Plugin Directory. Människor kan välja att flytta ifrån det, och det är helt naturligt.

Första platsen människor värd sina WordPress plugins efter WordPress.org Plugin Directory är GitHub. Med hjälp av det fantastiska revisionsstyrsystemet GitHub heter GitHub en av de bästa platserna att dela med dig av din open source-programvara med resten av världen. Och under de senaste åren har fler och fler WordPress-utvecklare publicerat sina nya plugins över GitHub.

Fördelar och nackdelar med att byta från WordPress.org Plugin Directory till GitHub

Jag tror att det finns en balans mellan fördelarna och nackdelarna med att hosta WordPress-plugins på GitHub istället för WordPress.org Plugin Directory. Jag kommer att lägga ut de som kommer att tänka mig, men jag skulle också älska din inmatning på det här, så tveka inte att skjuta en kommentar i avsnittet Kommentarer efter att ha läst detta.

När du är värd för dina plugins på WordPress.org:

• Du måste använda SVN.
• Din plugin måste godkännas av en WordPress.org-granskare innan du kan ladda upp den. (Det här är både en fördel och en nackdel för mig, eftersom det är bra att få en andra uppsättning ögon på koden för att upptäcka säkerhetsbrister.)
• Du kan bara använda GPL (version 2 eller senare) som licens.
• Dina plugin uppdateringar kommer snabbt meddelas dina användare.
• Uppdateringar av nödpluggar (av säkerhetsskäl) kommer automatiskt att tryckas på användarna.
• Människor kan hitta din plugin rakt från sina adminpaneler, vilket är ett stort plus.
• Du kan använda supportforum av WordPress.org.

Och när du bestämmer dig för att växla till GitHub:

• Du kommer att kunna använda Git.
• Du får oändligt mer frihet.
• Du kan använda andra typer av licenser (som MIT eller CC, även om CC inte rekommenderas för programvara).
• Du kan skapa en wiki, acceptera förbindelser och prata om problem med dina användare.
• Du kommer inte att ha några betyg för dina plugins, vilket är dåligt för feedback.
• Du måste slutföra denna handledning för att enkelt kunna göra plugin-uppdateringar.

Det finns också en bra debatt över på WordPress Tavern som jag tror-du borde också läsa.

Integrera WordPress GitHub Plugin Updater i ditt plugin

Klar för att ge uppdateringsanmälningar till dina användare?

Först och uppenbarligen måste du ladda ner WordPress GitHub Plugin Updater från sitt GitHub-arkiv. Du behöver bara updater.php fil, så oroa dig inte för de andra.

Därefter måste du sätta updater.php filen någonstans i din plugin-mapp och inkludera den i din plugin. Till exempel, om du sätter updater.php filen i en mapp som heter github-plugin-uppdateraren och du vill inkludera den i din huvudsakliga pluginfil, måste du lägga till följande rad i den filen:

Du måste också initiera WP_GitHub_Updater klass med de rätta argumenten för att ansluta din plugin till din GitHub repo:

 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 / användarnamn / repository-name / zipball / master ',' sslverify '=> sant,' kräver '=>' 3.0 ',' testat '=>' 3.3 ',' readme '=>' README.md ',' access_token '=> "), nya WP_GitHub_Updater ($ config);?>

• snigel: Din plugin slyp.
• proper_folder_name: Namnet på din plugin-mapp.
• api_url: Din GitHub repo API-URL.
• raw_url: Din GitHub repo rå URL.
• github_url: Din GitHub repo URL.
• zip_url: Din GitHub repo ZIP-adress.
• sslverify: Om du vill verifiera SSL eller inte.
• kräver: Den minsta WordPress-versionen som ditt plugin kräver.
• testade: Den maximala WordPress-versionen med vilken du testade ditt plugin.
• readme (avkodad): README-filen för att kontrollera pluginversionen från.
• access_token: Din GitHub-åtkomsttoken, om du använder en privat repo.

För att meddela dina användare är allt du behöver göra att ändra versionen av plugin-modulen i huvudfilens huvud. (Det verkar som om det här verktyget användes för att kontrollera README-filen för en rad som innehåller ~ Nuvarande version: X.X ~ men från version 1.6 ser den först efter huvudinställningsfilen.)

Och det är allt! Genom att följa dessa steg aktiveras uppdateringsanmälningar för ditt plugin.

Wrapping Up för idag

Om du vill vara värd för ditt WordPress-plugin på GitHub, och vill ge uppdateringsanmälningar till dina användare, är WordPress GitHub Plugin Updater ett av de viktigaste verktygen du ska använda.

Vad tycker du om det här verktyget eller värd för WordPress-plugins på GitHub i allmänhet? Dela dina tankar med oss ​​genom att kommentera avsnittet Kommentarer nedan. Och om du gillade artikeln, glöm inte att dela den med dina vänner!