はじめに
WordPressの公式サイトにプラグイン公開を申請して承認されると、Subversion(Gitに似ているが運用方法は異なる)のリポジトリURLが送られてきます。
自作のWordPressプラグインを公開しようとした際に避けては通れないSubversion(バージョン管理システム(以下VCS)について、今回はここに残していきたいと思います!
この記事では初めてプラグインを公開する場合の手順を書いていきますが、プラグインを更新する際の手順はこちらの記事を参考にしていただければと思います。
手順
- ターミナルからインストール
- ディレクトリをローカル環境に作成
- ディレクトリに移動
- リポジトリのチェックアウト
- クローンファイルにプラグインファイルの挿入
- リポジトリの追加準備
- リポジトリにコミット
詳しく見ていきましょう。
1.ターミナルからインストール
まずはSubversionをインストールしていきます。
ターミナルを開き、下記コードにてインストールしていきます。
$ brew install subversion
*Macの場合
2.ディレクトリをローカル環境に作成
ローカル環境に、Subversion用の任意のディレクトリを作成します。(今回はmy-plugins-svnという名前にします)
$ mkdir my-plugins-svn
ここで正しく生成されたか確認してみると良いでしょう。
「アプリケーション」や「ダウンロード」ファイルがあるディレクトリに下記のようにファイルが生成されていれば問題ございません
3.ディレクトリに移動
下記のコードで先ほど作成したディレクトリに移動していきます。
cd my-plugins-svn
*「my-plugins」に申請したプラグインのディレクトリの名前を入れてください
4.リポジトリのチェックアウト(ローカルにクローン)
Subversionのリポジトリからローカル環境(使用中のPC)にクローンを落とし込みます。
$ svn co https://plugins.svn.wordpress.org/my-plugins/
すると4つのファイルが落ちてきます。
A my-plugins_svn/assets
A my-plugins-name_svn/branches
A my-plugins-name_svn/tags
A my-plugins-name_svn/trunk
Checked out revision 000000.
ファイルの種類
assets:アイキャッチ画像を格納
アイキャッチ画像などの画像ファイルなどを格納するためのファイルです
trunk:プラグインファイルを格納
こちらのファイルに登録申請時のプラグインファイルを入れることになります。
tags:バージョン管理ファイルを格納
バージョン更新時などに使用しますが、後述します。
5.クローンファイルに作成したプラグインファイルの追加
落ちてきたクローンファイルに下記の要件にてファイルを入れてください。
アイキャッチ画像の種類と名前
プラグインページの画像は「banner-772×250.jpg」、「banner1544x500.jpg」
アイコンは「icon-128×128.jpg」、「icon-256×256.jpg」
6.リポジトリの追加準備(コミットの前段階)
ファイルへの追加が完了したら、addしていきます
svn add trunk/*
そうすると下記のようになります
A trunk/css
A trunk/css/style.css
A trunk/images
A (bin) trunk/images/no-image.png
A trunk/includes
A trunk/languages
A trunk/readme.txt
A (bin) trunk/screenshot-1.png
A (bin) trunk/screenshot-2.png
A trunk/uninstall.php
7.リポジトリに追加(commit)
下記のコードを入力し、リポジトリに追加させてください。
$ svn commit -m "First commit"
この際、”First commit”の部分は、のちにどんな変更などをしたか判別できるように、必ず記入しましょう。
初めてのコミットの場合
初めてのコミットの場合は、下記のパスワードの入力が求められます。
まずPCのパスワードを記入
Password for 'username':
次にwordpress.orgのアカウントのユーザー名を記入
Authentication realm: <https://plugins.svn.wordpress.org:443> Use your WordPress.org login
Username:
その後にwordpress.orgのアカウントのパスワードを記入
Password for 'username':
ここで一旦公開はされましたので公式ページにて、自身のプラグインを検索してみてください!
https://ja.wordpress.org/plugins/
バージョン管理
tagsにtrunkをコピーしておくことも忘れないで行いましょう。
こちらはバージョンを管理していく上で必要になってきます。
svn cp trunk tags/1.0.0
/trunkを/tag/1.0.0にコピーするという意味のコードを記入しましたが、まだローカル上でのコピーなので、これをコミットしていきます
$ svn commit -m "Tag 1.0.0"
最後に
今回は初めて自作プラグインを公開していくための手順を書きましたが今後更新などをしていく上での手順はこちらの記事を参考にしてみてください。