hatenablog-workflows

Usage

サンプル用のTemplate リポジトリをご確認ください

サブディレクトリで記事を管理する

各 reusable workflow は、Git で管理されている blogsync.yaml の親ディレクトリをブログ関連ファイルの基準ディレクトリとして自動的に使用します。

たとえばブログ関連ファイルを blog/ 配下に置く場合は、blogsync.yaml、draft.template、entries、draft_entries をまとめて移動してください。呼び出し側の workflow に基準ディレクトリを指定する必要はありません。

mkdir blog
git mv blogsync.yaml draft.template entries draft_entries blog/

blogsync.yaml はリポジトリ内に1つだけ配置し、必ず Git で管理してください。見つからない場合や複数見つかった場合は、曖昧なディレクトリで処理を続行せず、workflow がエラー終了します。

Workflows

initialize.yaml

• 初めてはてなブログと GitHub を連携するときに利用するアクションです
• はてなブログからすべての記事データ（公開済みおよび下書き）を取得します
  • 公開記事はentriesディレクトリ, 下書き記事はdraft_entriesディレクトリにそれぞれ配置されます
  • DateおよびURLは公開時に設定されることを想定しているため, 下書き記事ではこれらのメタデータは削除した状態で配置されます
• 本アクションで作成されたプルリクエストはマージしてもはてなブログへの同期(push)は行われません

create-draft.yaml

• 下書きファイルを新規作成するときに利用するアクションです
• タイトルの文字列を受け取って記事の新規作成, はてなブログへの同期とプルリクエストの作成を行います

pull-draft.yaml

• はてなブログから特定のタイトルの下書き記事を取得するときに利用するアクションです
• 引数にタイトルを渡して実行してください
  • 同一の下書きタイトルが複数ある場合, 意図しない挙動になる可能性がありますので一意の名前をつけてください
• タイトルと一致する下書き記事が取得できると, draft_entriesに当該の下書き記事ファイルが追加されたプルリクエストが作成されます

pull.yaml

• はてなブログから公開済みの記事のみを取得するアクションです
• entries配下に当該記事ファイルが追加, 更新されたプルリクエストが作成されます
  • 新たに追加, 更新のあった場合のみが対象です
  • 下書きファイルは取得対象外になっています
• 本アクションで作成されたプルリクエストはマージしてもはてなブログへの同期(push)は行われません

push-draft.yaml

• 下書きファイルの更新結果をはてなブログに同期するためのアクションです
• draft_entriesにある下書き記事の場合のみ, はてなブログに同期します
  • draft_entriesに対して変更があるたびに実行することを想定しております

push-when-publishing-from-draft.yaml

• 下書きファイルを初めて公開するときに利用するアクションです
• draft_entriesにある下書き記事を公開する変更があった場合, はてなブログへ記事を公開します
• また, 同期した記事をentriesに移動するプルリクエストを作成および自動マージします
  • main ブランチにマージされたときにのみ実行することを想定しています

push.yaml

• 公開済みの記事を更新し, はてなブログに反映するときに利用するアクションです
• entries内の更新のあった記事をはてなブログに同期します
  • main ブランチにマージされたときにのみ実行することを想定しています