はてなブログ開発ブログ

はてなブログからの公式のお知らせを発信します。

組織でのはてなブログ運営をGitHub上で行うためのテンプレートリポジトリ「HatenaBlog Workflows Boilerplate」を公開しました

GitHub上ではてなブログ運営を可能にするテンプレートリポジトリ「HatenaBlog Workflows Boilerplate」をベータ版として公開しました。

このテンプレートをご利用いただくと、組織でのブログ運営に求められるワークフロー(下書きの作成、更新、内容のレビューや公開など)をGitHub上で行うことができます。組織利用向けに整備していますが、どなたでもご利用いただくことが可能です。
導入方法や詳しい利用方法については、上記のリポジトリのREADMEをご参照下さい。

特長など

  • 下書きの作成時に、作成した下書きのみが含まれたプルリクエストを自動で作成します*1。コンフリクトを防ぎ、ワークフロー上の管理を容易にします
  • GitHub Actions を利用して動作するためローカルでの環境構築が不要です。GitHub組み込みのVisual Studio Code (github.dev)をご利用いただくことで、ローカルに環境を作ることが難しいエンジニア以外のスタッフでも編集が容易です
  • 記事の公開や公開記事の操作は main ブランチへのマージでのみ実行されます
    • 例えば、GitHubリポジトリの保護設定を行い、ブログメンバーの権限をすべて寄稿者に設定する*2ことにで、公開記事の操作を本テンプレート経由に限定する事が可能です*3

今後の予定

初回の公開では、GitHub上でのワークフローの確立を目標に開発を行いました。そのため、画像の自動アップロードなど改善は含まれていません。今後、画像のはてなフォトライフへのアップロードと記法の差し替え、下書きプレビューの改善など対応を予定しております。

どうぞご利用ください。

*1:下書き作成時に使用する GitHub Actions Workflow Dispatch により自動で作成されます

*2:寄稿者は自身が作成した下書き記事の編集のみ可能で、記事の公開や公開記事の編集を行うことはできません

*3:ただし、ブログのオーナーの認証情報、APIキーは別途管理しておく必要があります