1 of 42

Shifter Github Plugin/Theme Installer を使って、

独自テーマをインストール&更新しよう

~初心者のハマりポイントを添えて~

2022/02/10 Shifterオンラインミートアップ

株式会社ハタフル 清水 頌子(しみずようこ)

2 of 42

自己紹介

清水 頌子(しみずようこ)※Twitter などでは yshimizu と名乗っています

  • 福島県出身
  • 株式会社ハタフル�フロントエンドエンジニア(4月から講師も兼任)
  • 2021年春、はじめて Shifter を利用

3 of 42

  • 普通の WordPress 案件で独自テーマを使う場合・テーマファイルをサーバーにアップ超シンプル
  • Shifter で独自テーマを使う場合(~2019年9月頃)・FTP が使えないので、上記の方法が取れない�・WP Pusher か All-in-One WP Migration を使う必要があった� それぞれ都度設定変更やバックアップ取得などが必要手間がかかって大変

4 of 42

Shifter Github Plugin/Theme Installer

https://www.digitalcube.jp/shifter/10479/

5 of 42

Shifter Github Plugin/Theme Installer とは

  • Shifter チームが開発した WordPress プラグイン
  • FTP や WP Pusher、All-in-One WP Migration を使うことなく�テーマやプラグインを導入・更新できる(要GitHub管理)
  • Shifter にデフォルトでインストールされている

※Shifter でなくとも、プラグインをダウンロードして� インストールすれば利用することが可能� https://github.com/getshifter/shifter-github

6 of 42

使い方

DigitalCube の方々の記事を読もう

7 of 42

なんか上手くいかない

もうちょっと詳しく知りたい

8 of 42

「これが原因かも?」

「ココがポイント」

共有します!

9 of 42

用意するもの

  • Shifter Github Plugin/Theme Installer
  • GitHub管理下のWordPressテーマファイル
  • パーソナルアクセストークン(プライベートリポジトリの場合)

10 of 42

用意するもの

  • Shifter Github Plugin/Theme Installer
  • GitHub管理下のWordPressテーマファイル
  • パーソナルアクセストークン(プライベートリポジトリの場合)

11 of 42

プラグインの準備

  • Shifter を利用している場合�デフォルトでインストールされている�
  • それ以外の場合�公式リポジトリからダウンロードしよう�https://github.com/getshifter/shifter-github

12 of 42

用意するもの

  • Shifter Github Plugin/Theme Installer
  • GitHub管理下のWordPressテーマファイル
  • パーソナルアクセストークン(プライベートリポジトリの場合)

13 of 42

リポジトリの構成について

サンプルテーマを参考にしてファイルを収めよう�https://github.com/getshifter/shifter-github-hosting-theme-sample

具体的には

📁theme�└ 📁theme_name�  ├ index.php�  ├ style.css�  :

ここ以下のファイルを含めておけばOK

14 of 42

用意するもの

  • Shifter Github Plugin/Theme Installer
  • GitHub管理下のWordPressテーマファイル
  • パーソナルアクセストークン(プライベートリポジトリの場合)

15 of 42

パーソナルアクセストークンが無いと…?

  • 権限周りの問題でテーマインストールできない�テーマインストール時に「Not Found」と表示されるだけ

私はこれで3時間ぐらい溶かしました🤮

※サポートの方の的確な指示で事なきを得ました

16 of 42

リポジトリの権限が原因のインストール失敗例

こうならないためにも、�リポジトリの権限を確認して�パーソナルアクセストークンを�取得しよう!

17 of 42

パーソナルアクセストークンの取得方法

  1. GitHubで自分のアイコンをクリック
  2. Settings から Developer settings へ進む
  3. Personal access tokens を選択
  4. Generate new token をクリック
  5. Note を適当に書き、「repo」にのみ✓を入れて発行

※表示されたトークンは画面を閉じると二度と表示されないので、大事に取っておく�※仮に忘れてしまっても再発行可能なのでご安心を

18 of 42

19 of 42

20 of 42

① 一覧表示用に命名� (無くても良い)

repo のみに✓

③ Generate token!

21 of 42

いよいよ導入!

22 of 42

GitHub Actionsの準備

  • リリースパッケージの自動生成に必要�・リリースパッケージって何?�・修正のたびに毎回パッケージを作るのは面倒 設定を進めよう

23 of 42

GitHub Actionsの準備

サンプルテーマから .github/workflows を丸ごと取得しておこう�

コレです

24 of 42

誤ってサンプルプラグインのものを使うと…?

  • エラーが発生して処理が停止する�エラーの内容自体は GitHub Actions 側のログで確認可能

テーマファイルをリポジトリに収めるときに�階層の確認ついでに作業すると良いかも🤔

※サンプルテーマのもので書き直せば大丈夫�※原因に関わらずエラーログは読もう

25 of 42

release.yml の内容を書き換える

  • 「PACKAGE_NAME」と「FILES_TO_ARCHIVE」を書き換える

26 of 42

release.yml の内容を書き換える

  • PACKAGE_NAME はリポジトリの名前と合わせる
  • FILES_TO_ARCHIVE は含めたいファイルやディレクトリを設定�自分のテーマに合った設定に書き換えよう

27 of 42

テーマファイル直下の style.css を書き換える

  • Version を {release version} に書き換える

28 of 42

リリースパッケージ生成テスト

  • タグを 0.0.1 のような表記で発行して、プッシュする�つけたタグがそのままテーマのバージョン番号になる

以降、パッケージを生成(ファイルの更新)をするときは�前回より大きい番号を指定してこの作業を行う

29 of 42

前回より小さいバージョン番号を付けると…?

  • 更新されない�エラーログも特に残らな

私は2回ぐらいやらかしました😇

※大きいバージョン番号のタグを� 改めて発行してプッシュすれば大丈夫�※一向に更新が降りてこないときは大体これが原因(当人比)

30 of 42

0.1.6 0.1.61 0.1.7

31 of 42

0.1.6 0.1.61 0.1.7 0.1.62

😊

32 of 42

リリースパッケージ内容確認

  • 「Releases」の欄を確認する�タグで設定したバージョン番号で履歴が載っていればOK�
  • 「Assets」からパッケージを確認する�以下3ファイルがあればOK�- リポジトリ名.zip�- Source code (zip)�- Source code (tar.gz)

33 of 42

リリースパッケージ内容確認

  • 実際に「リポジトリ名.zip」をダウンロード&展開する�ファイルに過不足がないかを確認する

これらの確認作業で何らかの不備があったときは release.yml を見直そう�・PACKAGE_NAME がリポジトリ名と一致していない�・FILES_TO_ARCHIVE での拡張子 / ディレクトリ指定漏れ

34 of 42

いざ、インストール!

35 of 42

① WordPress の管理画面を開く

外観 > Add New from GitHub をクリック

※見つからない場合はプラグイン自体のインストールと 有効化を確認しよう

※今回はテーマインストールなので、外観の方を選ぶ

36 of 42

とっても簡単!

素敵なプラグインをありがとう、Shifter チーム!

GitHub repo URL に、テーマの�  リポジトリURLを入力する

必要があれば GitHub token に�  パーソナルアクセストークンを�  入力する

⑤ 今すぐインストール!

37 of 42

更新してみよう

38 of 42

ファイル更新��タグ発行&プッシュ��(リリースパッケージ生成)��管理画面で更新

更新作業の流れ

39 of 42

  • 更新通知が全然来ない バージョン番号を確認しよう�
  • 通知が入ったバージョン番号が最新のものより古い 短時間にたくさんリリースパッケージを生成すると陥りがち�  Shifter の場合は、一度WordPressを再起動してみよう

更新に関するトラブルシューティング

40 of 42

何かがおかしいと思ったら

  • リポジトリ周りの権限を確認しよう
  • 目的に合った release.yml を使おう
  • release.yml と style.css の編集内容を見直そう�(リポジトリ名と合致しているか、ディレクトリに指定もれはないか etc.)
  • バージョン番号は大きいものを指定しよう
  • エラーログは読もう
  • Shifterを使っているなら、サポートに相談しよう

41 of 42

Thank you !

42 of 42

付録