Ajouter un plugin Piwik à la Marketplace

Saviez-vous que vous pouviez ajouter les plugins que vous avez créés à la Marketplace de Piwik pour que toute la communauté puisse en profiter ?

Pour ce faire, il vous suffit de suivre le tutoriel ci-dessous.

Être en règle

Dans un premier temps, il faut que votre plugin respecte les règles suivantes :

• votre plugin ne doit en aucun cas enfreindre la loi ;
• votre plugin ne peut pas collecter de données pour votre utilisation personnelle à l’insu de son utilisateur ;
• votre plugin doit contenir une page README.txt, et cette page ne doit pas contenir de liens commerciaux ;
• votre plugin ne doit pas violer les règles relatives à la marque Piwik.

Préparer son plugin pour la Marketplace

Avant de proposer votre plugin à la Marketplace de Piwik, il faut que vous complétiez au maximum le fichier appelé « plugin.json » situé dans votre dossier de plugin.

Ce fichier contient toutes les informations sur le plugin (auteur, version, description, etc.).

C’est-à-dire remplir les champs suivants :

    "name": "SimpleVisits",
    "description": "Affichez clairement et simplement votre nombre de visites sur votre tableau de bord !",
    "version": "0.1.0",
    "theme": false,
    "require": {
        "piwik": ">=3.0.3-stable,<4.0.0-b1"
    },
    "authors": [
        {
            "name": "Ronan Chardonneau",
            "email": "support@mail.com",
            "homepage": "https://twitter.com/chardonneaur"
        }
    ],
    "support": {
        "email": "",
        "issues": "",
        "forum": "",
        "irc": "",
        "wiki": "",
        "source": "",
        "docs": "",
        "rss": ""
    },
    "homepage": "",
    "license": "GPL v3+",
    "keywords": ["SimpleVisits", "Visits", "Simple", "Show", "Counter"]

Ensuite, Piwik recommande un fichier README.txt rédigé et complet (en anglais si possible, ou multilingue).

Votre fichier README.txt sera lu par la communauté de Piwik : il est donc important qu’il soit correctement rédigé !

Ajoutez votre plugin sur GitHub

Ensuite, il faut que vous ajoutiez votre plugin à GitHub.

Pour cela, créez-vous un compte, puis créez un nouveau projet (repo).

Utilisez Git, GitKraken ou un simple upload pour ajouter tous les fichiers du plugin au repo de votre GitHub.

1. Accédez aux paramètres du repo en cliquant sur le bouton Réglages.
2. Rendez-vous sur Intégrations & Services.
3. Cliquez sur Ajouter un service.
4. Recherchez « Piwik Plugins ».
5. Cliquez sur Activer.
6. Cliquez sur Ajouter le service.

Désormais, la Marketplace de Piwik recevra une notification à chaque fois que vous enverrez ou modifierez votre projet GitHub.

Vous venez donc de faire une demande de publication auprès de la Marketplace !

Félicitations, votre plugin sera publié sur la Marketplace d’ici quelques minutes !