Git Download Updater – Documentation d'installation

L'extension Git Download Updater prend en charge GitHub et BitBucket.

Connexion à BitBucket

Pour connecter votre site Easy Digital Downloads à votre compte Bitbucket, vous devrez créer une APPLICATION dans votre compte Bitbucket, puis ajouter le mot de passe de l'application et votre nom d'utilisateur Bitbucket dans les paramètres de l'extension.

Pour créer un mot de passe d'application, suivez les étapes ci-dessous :

1. Dans l'icône de roue dentée en haut à droite, sélectionnez Paramètres personnels Bitbucket.
2. Sélectionnez Mots de passe d'application sous Gestion d'accès.
3. Sélectionnez Créer un mot de passe d'application.
4. Donnez au mot de passe d'application un nom qui vous aidera à vous souvenir de son utilité.
5. In the Permissions section check the boxes for:
   • Compte > E-mail et Lecture
   • Appartenance à l'espace de travail > Lecture
   • Projets > Lecture
   • Dépôts > Lecture
6. Copiez le mot de passe généré dans un endroit sûr pour l'instant. Le mot de passe n'est affiché qu'une seule fois.

Voici une image de toutes les autorisations requises décrites à l'étape 5 ci-dessus :

Plus de détails sur les mots de passe d'application (y compris leur utilisation et leur révocation) sont disponibles dans la documentation de Bitbucket documentation.

Une fois que vous avez le nouveau mot de passe d'application, ajoutez-le à la page Téléchargements > Paramètres > Extensions > Git Updater.

Le champ Nom d'utilisateur est votre nom d'utilisateur Bitbucket réel (ne pas le confondre avec l'adresse e-mail du compte). Vous pouvez facilement le trouver sur cette page : https://bitbucket.org/account/settings/ dans la section « Paramètres du profil Bitbucket ».

Connexion à GitHub

Pour utiliser GitHub, accédez à Téléchargements > Paramètres > Extensions > Git Updater. Suivez les instructions fournies pour vous connecter à GitHub.

Configuration d'un téléchargement avec Git Updater

Définition de vos fichiers de téléchargement

Une fois que vous avez connecté votre site Web à GitHub ou Bitbucket, vous pouvez ajouter des fichiers à vos produits de téléchargement.

1. La boîte de métadonnées « Fichiers de téléchargement » sur l'écran de modification du téléchargement comportera désormais une case à cocher intitulée « Récupérer le téléchargement depuis un dépôt git ».

2. Après un moment, un nouvel ensemble de champs apparaîtra, vous permettant de sélectionner un dépôt.

3. Recherchez le nom du dépôt, puis sélectionnez l'étiquette que vous souhaitez utiliser.

Remarque : L'étiquette de version utilisée dans Git Updater doit être une étiquette git native. Elle n'analyse pas les versions de votre fichier readme. Pour en savoir plus sur l'utilisation de la fonctionnalité d'étiquette dans git, vous pouvez visiter ce guide.

4. Cliquez sur « Récupérer maintenant ». Lorsque votre téléchargement a été importé avec succès depuis le dépôt git, le bouton indiquera « Récupéré ».

5. Vous pouvez maintenant modifier le nom du fichier et/ou du zip si vous le souhaitez, ou les laisser par défaut. Votre fichier zip est prêt !

Lorsque vous êtes prêt à publier une nouvelle version, sélectionnez simplement la balise que vous souhaitez utiliser et cliquez sur récupérer. Une fois la récupération terminée, mettez à jour votre produit.

FAQ et dépannage

Comment exclure ou supprimer des fichiers avant la génération de l'archive zip ?

Le Git Download Updater utilise la fonctionnalité « export » de Git pour construire le fichier à livrer. Vous pouvez utiliser le fichier `.gitattributes` pour déterminer quels fichiers vous souhaitez ignorer lors de l'exportation. Voici un exemple de la façon dont nous l'utilisons pour EDD Core.

Pour plus de détails sur l'utilisation des attributs git pour exclure des fichiers, consultez ce tutoriel.

Conflit de mise à jour entre la version gratuite et la version payante

Il existe deux manières différentes de résoudre ce problème :

1. Modifiez le nom et/ou le slug de la version pro. En raison d'une subtilité de l'API de mise à jour de WordPress, WordPress ne peut pas les distinguer comme des plugins distincts.
2. Ajoutez « wp_override » au troisième paramètre de la classe EDD_SL_PLugin_Updater lors de son instanciation, comme ceci :

// set up the updater
$edd_updater = new EDD_SL_Plugin_Updater( EDD_SAMPLE_STORE_URL, __FILE__, array(
		'version'     => '1.0', 				// current version number
		'license'     => $license_key, 		// license key (used get_option above to retrieve from DB)
		'item_id'   => EDD_SAMPLE_ITEM_ID, 	// name of this plugin
		'author'      => 'Easy Digital Downloads',  // author of this plugin,
		'wp_override' => true
	)
);

Note : cela nécessite la v1.6.4 de la classe de mise à jour de plugin.