Git Download Updater – Installatiedocumentatie

Wanneer u een nieuwe versie van een plugin of thema uitbrengt, betekent het gebruikelijke proces het downloaden van een zip uit uw repository, het hernoemen van de map en het opnieuw uploaden ervan naar uw winkel.

De Git Download Updater-functie automatiseert dit proces voor code die wordt gehost op GitHub of Bitbucket. Het haalt rechtstreeks uit een versie-tag of release, beheert bestandsnamen en houdt de downloadbestanden van uw winkel gesynchroniseerd met uw repository.

---

Vereisten

Verbinding maken met GitHub

GitHub-verbindingen gebruiken OAuth, wat een eenmalige installatie in uw GitHub-account vereist. U maakt een GitHub OAuth-app aan, plakt de gegevens ervan in uw EDD-instellingen en autoriseert vervolgens de verbinding.

Stap 1: Maak een GitHub OAuth-app

• Ga naar Downloads » Instellingen » Extensies » Git Updater.
• Klik onder GitHub-status op de link Een applicatie aanmaken. Dit opent de pagina voor het aanmaken van een OAuth-app van GitHub in uw GitHub-account.

• Vul de toepassingsgegevens in. Stel zowel de Hoofd-URL (Homepage URL) als de Callback-URL (Authorization callback URL) in op de URL van uw site (bijvoorbeeld https://uwsite.com).
• Sla de app op. GitHub toont een Client ID en stelt u in staat een Client Secret te genereren. Kopieer beide waarden.

Stap 2: Verbind GitHub in EDD-instellingen

• Ga terug naar Downloads » Instellingen » Extensies » Git Updater.
• Plak uw Client ID en Client Secret in de respectieve velden.
• Selecteer Wijzigingen opslaan.
• Klik op Autoriseren met GitHub. U wordt doorgestuurd naar GitHub om de verbinding goed te keuren. Na goedkeuring keert u terug naar uw EDD-instellingen met GitHub verbonden.

---

Verbinding maken met Bitbucket

Bitbucket-verbindingen gebruiken een API-token dat is gekoppeld aan uw Atlassian-account. U maakt het token aan op id.atlassian.com onder Beveiliging » API-tokens, voer vervolgens uw e-mailadres en token in uw EDD-instellingen in.

Stap 1: Maak een Bitbucket API-token

1. Ga naar Downloads » Instellingen » Extensies » Git Updater.
2. Klik onder Bitbucket Status op een API-token aanmaken.
3. Geef het een beschrijvende naam (bijvoorbeeld “EDD Git Updater”).
4. Selecteer onder App Bitbucket.
5. Schakel alleen de volgende scopes in: read:workspace:bitbucket (Werkruimten weergeven) en read:repository:bitbucket (Repositories weergeven).
6. Sla het token op en kopieer het. Deze waarde wordt slechts één keer weergegeven.

Stap 2: Verbind Bitbucket in EDD-instellingen

1. Ga terug naar Downloads » Instellingen » Extensies » Git Updater.
2. Voer het e-mailadres in dat u gebruikt om in te loggen bij Atlassian in het veld Atlassian Account Email.
3. Plak uw token in het veld Bitbucket API Token.
4. Klik op Wijzigingen opslaan.

⚙️ Meer details vindt u in de Bitbucket documentatie.

---

Een download configureren om Git Updater te gebruiken

Het downloadbestand instellen

1. Open een download in de EDD-editor en zoek de sectie Download Details » Bestanden.
2. Selecteer de optie Download ophalen uit een git-repository. Er verschijnen nieuwe velden.
3. Zoek onder de Git Repository naar uw repositorynaam en selecteer deze uit de dropdown.
4. Selecteer de versie-tag die u aan klanten wilt aanbieden. (Opmerking: De Versie-tag die in Git Updater wordt gebruikt, moet een native git-tag zijn. Het parseert geen versies uit uw readme-bestand. Om meer te leren over het gebruik van de tag-functie in git, kunt u deze gids bezoeken.)
5. Klik op Nu ophalen. De knop verandert in Opgehaald wanneer voltooid.

Naam van pluginmap

Het veld Plugin Map Naam bepaalt de naam van de map binnen het zip-bestand dat klanten downloaden. Deze waarde moet exact overeenkomen met de geïnstalleerde mapnaam van uw plugin of thema op de site van de klant.

Belangrijk: Als de Plugin Map Naam niet overeenkomt met de geïnstalleerde mapnaam, zullen updates voor klanten stilzwijgend mislukken. WordPress zal geen zichtbare foutmelding geven, maar de update zal niet correct worden toegepast. Controleer deze waarde dubbel voordat u opslaat.

Selecteren van een GitHub Release Asset

Als u vooraf gebouwde releasebestanden op GitHub publiceert (bijvoorbeeld een verpakt en gecompileerd zip-bestand), kunt u dat bestand rechtstreeks aanbieden in plaats van het ruwe bronarchief te gebruiken.

Nadat u een versie-tag hebt geselecteerd, verschijnt er een dropdown Release Asset. Kies het bestand dat u aan klanten wilt aanbieden. Dit is handig wanneer de broncode van uw repository een build-stap vereist voordat deze kan worden gedistribueerd.

Versie Terugdraaien

De versie-tag-dropdown toont alle beschikbare tags in uw repository, niet alleen de nieuwste. Om een oudere versie te leveren, selecteert u een eerdere tag uit de dropdown en klikt u op Nu ophalen. Dit is handig om snel een release terug te draaien als een nieuwe versie een probleem heeft.

---

Een routine-update uitvoeren

Wanneer u klaar bent om een nieuwe versie uit te brengen, duurt het proces vier stappen:

1. Open de download in uw EDD winkel.
2. In de Download Details » Bestanden metabox, wijzigt u de versie-tag naar de nieuwe versie.
3. Klik op Nu ophalen.
4. Sla de download op.

---

Belangrijke termen

Tag: Een label dat op een specifiek punt in uw codegeschiedenis wordt geplaatst, meestal om een releaseversie aan te duiden (bijvoorbeeld, v1.2.0). Git Updater gebruikt tags om te weten welke versie van uw code moet worden opgehaald en geleverd aan klanten.

OAuth: Een veilige autorisatiemethode waarmee uw site verbinding kan maken met uw GitHub-account zonder uw wachtwoord op te slaan. Wanneer u op Autoriseren met GitHub klikt, verleent u toegang via OAuth.

API-token: Een code die fungeert als een wachtwoord met beperkte toegang, waardoor uw site toestemming krijgt om uw Bitbucket-account te lezen. In tegenstelling tot uw werkelijke wachtwoord, kan een API-token op elk moment worden ingetrokken zonder uw inloggegevens te wijzigen.

Opmerkingen

• Variabele prijzen: Variabele prijsniveaus worden ondersteund. Elke bestandsrij in de metabox Bestanden kan worden toegewezen aan een ander prijsniveau.
• Repository-cache: Repository-lijsten worden in de cache opgeslagen. Als een nieuw verbonden repository niet onmiddellijk in de dropdown verschijnt, slaat u de instellingenpagina op om de cache te vernieuwen.
• Changelog-updates: Automatische changelog-updates vereisen dat Software Licensing op uw site is geïnstalleerd en actief. Zie de Software Licensing-documentatie voor installatie-instructies.

---

Probleemoplossing

Plugin toont een fout na activering
De PHP ZipArchive-extensie ontbreekt waarschijnlijk in uw hostingomgeving. Neem contact op met uw hostingprovider en vraag hen om ZipArchive in te schakelen.

Repository-dropdown is leeg
Uw inloggegevens zijn mogelijk onjuist of uw token heeft mogelijk niet de vereiste machtigingen. Controleer de velden in Downloads » Instellingen » Extensies » Git Updater en sla de instellingenpagina op om de repository-cache te vernieuwen.

Nu ophalen time-out
De maximale uitvoeringstijd van uw server is mogelijk te laag voor grotere repositories. Neem contact op met uw hostingprovider om de limiet te verhogen, of schakel over op het leveren van een vooraf gebouwd GitHub-release-asset in plaats van het ophalen van de ruwe bron.

Klanten ontvangen geen updates
Het veld Plugin Folder Name is waarschijnlijk onjuist ingesteld. Het moet exact overeenkomen met de geïnstalleerde mapnaam van uw plugin of thema. Corrigeer de waarde en klik opnieuw op Nu ophalen om opnieuw op te halen met de juiste mapnaam.

Bestanden uitsluiten van de geëxporteerde zip
Gebruik een .gitattributes bestand in uw repository om te bepalen welke bestanden worden uitgesloten tijdens de export. Zie EDD's eigen .gitattributes bestand als referentievoorbeeld.

Conflicten tussen gratis en betaalde versies
Als uw gratis en betaalde versies dezelfde plugin slug delen, hernoem dan de slug in uw betaalde versie of voeg wp_override toe als parameter bij het instantiëren van de EDD_SL_Plugin_Updater klasse (vereist v1.6.4 of later).