ニュース

Piwikマーケットプレースであなたのプラグインやテーマを公開する方法 Piwikのプラットフォームの紹介

2014年09月29日 トピックス ニュース

それではブログシリーズの新しい記事、Piwik プラットフォームの機能を紹介します。この数週間にわたって、既にプラグインやテーマを作成する方法の基本を紹介してきました。今回はすべてのPiwikのユーザーと共有するPiwikマーケットプレイスで、プラグインやテーマを公開する方法を学びます。

Piwikマーケットプレイスとは

Marketplaceは、Piwikで使用できるすべてのプラグインやテーマのショーケースです。セッティング -> マーケットプレイスからスタンドアロンのウェブサイト上またはPiwik自体のいずれかで、それらを閲覧することができます。それらはワンクリックでインストール及びアップデートできます。とても簡単です！
一部のプラグインはPiwik及び InnoCraftによって提供されますが、ほとんどはコミュニティによって作成、維持されています。マーケットプレイスでのプラグインやテーマの配布はどなたでも大歓迎です。

前提条件

マーケットプレース上でプラグインを公開するには以下の条件を満たす必要があります:

  • プラグイン名は他のプラグインで使用されていないものに限る
  • プラグインのコードはパブリックGitHubのリポジトリでホストされている
  • GitHub サービス「Piwik プラグイン」このリポジトリに対しては有効になっている(Repository Settings => Webhooks & Services => Add Service)
  • このリポジトリのアクセス許可をプッシュ
  • 無料で公開すること
  • ライセンスは GNU General Public License v3 またはそれ以降のバージョンとの互換性があること

プラグインのルールの一覧

ベストプラクティス

実際にプラグインを配布する前に、そのプラグインがマーケットプレース上での有用性、また、将来のユーザーのための有用な情報を提供することを確認し、ベストプラクティスのいくつかに従うことをお勧めします。プラグインを生成するため、コンソールを使用している場合、必要なファイルが既に作成されています。

判り易い説明を入力します。

作成したプラグインのルートに README.md という名前のファイルがあることを確認します。
Description, FAQ, Changelog and Support：マーケットプレイスにプラグインを準備するとき、このファイルの4つのセクションを検索します。それぞれ任意ですが、少なくとも、セクション Description と Support には ## を付けて登録することをお勧めします。これらのセクション外に readme ファイルのすべてのコンテンツは、マーケットプ レースでは表示されません。

# Piwik Plugin Name

## Description

Add your plugin description here.

## Support

Please direct any feedback to hello@piwik.org. 
If you experience any issues feel free to file an issue at https://github.com/piwik/piwik/issues .

良い例は、プラグインCustomAlertsのREADME.mdおよび関連CustomAlertsプラグインのページで見ることができます。

スクリーンショットを登録します

これはマーケットプレイスでのあなたの外観を向上させ、多くユーザーがあなたのプラグインをインストールするようになるでしょう。screenshotsフォルダ内に、「PNG」または「JPG」ファイルを配置するのと同じくらい簡単です。アンダースコアは空白文字に置き換え、UI の各イメージのファイル名が表示されます。このように素敵な説明を入力できます。それがどのように動作するかを確認するプラグインCustomAlertsでご覧になれます。

連絡先の詳細を入力します

あなたの連絡先の詳細は、プラグインのルートフォルダのplugin.jsonファイルで指定します。少なくとも 1 人の著者と自分のホームページにリンクを入力することが必要です。ウェブサイトを持っていない場合 GitHub のプロフィールへのリンクを使用できます。これにより、ユーザーが問題を報告したい場合や、またはあなたの素晴らしい仕事に感謝したい場合はご連絡できます。
例 plugin.json は、このようになります：

{
    "name": "MyPluginName",
    "homepage": "http://piwik.org",
    "authors": [
        {
            "name": "Piwik",
            "email": "hello@piwik.org",
            "homepage": "http://piwik.org"
        }
    ],
    "support": {
      "email": "hello@piwik.org",
      "issues": "https://github.com/piwik/piwik/issues",
      "forum": "http://forum.piwik.org",
      "wiki": "https://github.com/piwik/piwik/wiki",
      "irc": "#piwik-dev"
    } 
}

ライセンスを選択します。

あなたとユーザーにとって最適なライセンスを選択することが重要です。Piwik マーケットプレイス経由でプラグインを配布するには、ライセンスは GNU General Public License v3 またはそれ以降のバージョンとの互換性がある必要があります。プラグインのライセンスを指定しない場合は、以降GPLv3を使用するプラグインとみなされます。ライセンスはプロパティlicenseを使用してplugin.jsonファイルで指定する必要があります。

{
    "name": "MyPluginName",
    "license": "GPL v3+"
}

寄付のリンクを提供します。

plugin.json ファイルで PayPal、Flattr、Bitcoin の寄付リンクまたは電子メールを定義できます。あなたの仕事を愛するユーザーは、プラグインのページから直接お金を寄付することができます。

{
    "name": "MyPluginName"
    "donate": {
        "paypal": "sponsor@piwik.org",
        "flattr": "https://flattr.com/profile/piwik",
        "bitcoin": "1234567890"
    }
}

プラグインの最初のバージョンを発行する方法

マーケットプレイスでのプラグインの公開をできるだけ簡単にしようとしています。だからこそ我々 は、任意のログインまたはパッケージングを必要としません。プラグインを公開するには、新しいタグを作成する必要があり、数分以内にプラグインが何十万ものPiwikにインストールすることができるようになります。

プラグインにタグを付けるには、次の2つの提案のいずれかを使用してください。

コマンドラインを使用

git tag 0.1.0 && git push --tags

ここで”0.1.0″ は、タグの名前です。任意のタグ名を使用できますが plugin.json ファイルで定義されている現在のバージョン番号を使用するお勧めします。

GitHub の UI を使用

GitHub のクリックで新しいバージョンのリリースにタグを付けるには => Draft a new release
github_distribute_plugin_1

これで、タグ名（バージョン）を押し、この画面のように「Publish release」を入力できます。以上です！
github_distribute_plugin_2

プラグインのアップデートを提供する方法

アップデートを提供するには、専用のファイルplugin.jsonにバージョン番号を増加させ、前のセクションで説明したように別のタグを作成する必要があります。新しいプラグインの更新が数分程度以内にマーケットプレイスに表示されます。更新は各PiwikのサーバとPiwik内の更新数時間ごとにチェックしており、自分自身が表示されるまでにはいくらか時間がかかる場合があります。

情報の完全なリストは、Piwik Developer Zone でプラグインの配布ガイドを参照してください。

APIまたはDeveloper Zoneにおける手引きに関してのフィードバックはお気軽にお寄せ下さい。

thomas_s-150x150Thomas Steur

Thomasはドイツの名門ソフトウェア会社で働くソフトウェア·エンジニアです。彼は何千人ものユーザーが数十週に渡って使用している当社のPiwik モバイル アプリを作成し、現在の開発リーダーでもあります。Thomasは常により良いPiwikのモバイルを作るために新しいアイデアを試みています。もしアプリ使用しているのであれば、沢山の提案やアイデアのフィードバックをお願いします。
カテゴリー
アーカイブ