WordPress連携(β版)

WordPress連携機能についての説明です。

機能

外部のWordPressサイトをUsusamaの新着情報としてコードを生成します。

使い方

A. Github

WordPressサイト更新時の自動ビルドに「Github Actions」を使用するため、Githubの設定も必要となります。

1. リポジトリの作成: Ususamaを利用しているプロジェクトのリポジトリを作成し、masterブランチにプッシュします
2. Github Actionsの有効化: リポジトリに対してGithub Actionsを有効にします
3. Secretsにサーバ情報を設定: 「Settings」→「Secrets」と進み、ワークフローで使用する4つのキー(でポロイ先サーバのFTP情報)を設定します。
   • ftp_user: FTPユーザ名
   • ftp_password: FTPユーザのパスワード
   • ftp_host: ホスト名
   • ftp_remoteroot: デプロイするパス
4. Personal access tokensの設定: 「Personal access tokens」を設定し、トークンを控えます

B. WordPress

1. WordPressの構築: WordPressサイトを別途構築します(「投稿」のみ使用します)
2. プラグインのインストール&有効化: Karura-enをZipダウンロードし、1.のWordPress管理画面の「プラグイン」→「新規追加」でzipファイルをアップロードし、プラグインをインストール&有効化を行う
3. プラグインの設定WordPress管理画面のメニューに「迦楼羅焔設定」が追加されるので、設定画面を開きます。
   そして、A.で作成したGithubのリポジトリの情報(ユーザID、リポジトリ名)とPersonal access tokensを入力します

C. Ususama

1. bin/config/plugins.ymlのwordpressをtrueにします
2. bin/config/config.ymlのparam.news.wpapiにWPサイトのWP REST APIのURLを記述します
   (例: https://wpsite.example.com/wp-json/wp/v2/posts)

留意点

本機能の利用の際にはいくつかの制約が発生します。

A. Github

• 対象ブランチはmasterのみとなります

B. WordPress

• 扱うデータについて: WordPressの「投稿」を新着情報として扱います。「固定ページ」や独自に追加した「カスタム投稿タイプ」は対象外となります(必要ならば、独自にgulp/tasks/ejs.jsのejsビルドタスクをカスタマイズしてください)。
• 画像などのファイルについて: WordPressの記事中に挿入する画像については、CDNサービス等を使ってWordPressサイト外に画像データがある状態としてください
• サイト内リンクについて: WordPressサイト内のリンクについては、自動置換は行いません