GitHub Actionsのデプロイ用のワークフローで公開した記事のURLをわかるようにしたい

[neko314]

背景

記事のPRをmasterにマージしたらその記事が公開されるが、該当のURLがなんなのかはアナログで見つけて「URLはこちらです https://〜」というようなコメントをしている。このURLは機械的に生成されるものなのだが、毎回手打ちするのはちょっと面倒なのと、生成ルールを知らないと該当URLにはなかなか辿り着けない。

やりたいこと

公開した記事のURLを簡単に見つけられるようにしたい。
デプロイのワークフローのログに含めるとかSlackやDiscordへの通知とかいくつか考えられそう。

編集部も人が増えてきたり色々な人が関心を持ってくださったりしているので、誰がみてもわかるようにしたい。

その他

今のるびまの作りとして、作成中の号の記事へのリンクが表出してない点も改善の余地はあるのだけど、どういう感じに解決すればいいかアイディアがすぐに浮かばないし作業としては全く別物となるはずなので、るびま自体の構造を変えるのは別課題として扱うことにして、このissueをまずは解決したい。

[zunda]

現在は、masterへのプッシュをトリガーとして .github/workflows/jekyll.yml に従ってJekyllが過去のものも含めてすべての記事をビルドしてデプロイしているように見えます。もしそうなら、

1. どうにかして、前回のデプロイと比較して増えた記事を検出して、
2. 生成ルールに従ってURLを生成して、
3. それら（１つ以上）のURLを通知する

ことになりそうです。GitHub Actionsの有識者のかた〜

[zunda]

上記(1)について。

GitHub ActionsではAction内でのビルドの結果をアップロードしたりダウンロードすることができるようです。前回のビルドの結果をダウンロードするにはアクセストークンを設定する必要もあるみたい。

Jekyllがビルドした記事をリストしたファイルを生成してくれるのならば、それをアップロードしておいて、次のビルドの時に生成されたファイルと比較することで、増えた記事を検出できるかもしれません。

[neko314]

1へのアプローチで、そもそも差分だけ再生成するオプションがjekyllにあるらしく。これが活用できると早いかもしれないです。
https://jekyllrb.com/docs/configuration/incremental-regeneration/

experimentalなので、そもそもこのオプションを有効にしてちゃんと動くのかを確かめるところからですかね〜

[zunda]

手元で少し試してみました。

• Incremental Regenerationを利用するには、GitHub Actionsによる前回のビルドから、./_site/以下のアーティファクトと./.jekyll-metadataファイルを引き継いで、今回のビルドのために展開する、また、
• 新しいポストを検出するためには、どうにかしてjekyll buildコマンドに新しいポストのリストを教えてもらうか、./.jekyll-metadataファイルなどの変化を検出する

必要がありそうです。詳細を https://github.com/zunda/zunda.github.io/blob/master/_posts/2026-01-14-jekyll-incremental-regeneration.md に書きました。(GitHub Actionsを試すついでに https://blog.zunda.ninja/jekyll/update/2026/01/15/jekyll-incremental-regeneration.html でも見えるようになっていますw)

[zunda]

ビルドしたページをJekyllに教えてもらう手順をなかなかみつけられないので、ちょっと脱線してRSSフィードを利用して新しいページを検出してみました。この方法はGitHub Workflowにビルド結果のアーティファクトやキャッシュを保管しておいてもらう必要がない利点がありそうですが、何かの理由でRSSを公開できない場合には使えません。

_config.ymlで

plugins:
  - jekyll-feed

とプラグインが有効になっていれば、ページのビルドの時にfeed.xmlというRSSフィードを作ってくれるようです。前回のビルド・デプロイによって公開されたRSSフィードと、今回のビルドで生成されたRSSフィードとの差分を、例えば下記のようなスクリプト(script/find_new_pages.rb)で計算して、新しいページのURLをGitHub Actionsのログに記録することができました。

# Detect new pages from RSS feeds
require "rss"
require "uri"

base_url = "https://blog.zunda.ninja"
latest_rss = "./_site/feed.xml"
public_rss = base_url + "/feed.xml"

begin
  # Compare paths of posts.
  # ignoring shceme and hostname which maybe different with `jekyll serve`
  new_paths = [
    RSS::Parser.parse(File.read(latest_rss)), # current build
    RSS::Parser.parse(public_rss)             # prebious deploy
  ].map{|feed| feed.items.map{|item| URI.parse(item.link.href).path}}.inject(:-)

  if new_paths.empty?
    puts "No new pages."
  else
    puts "New pages:\n#{new_paths.map{|path| base_url + path}.join("\n")}"
  end
rescue => e
  # Let build continue even we failed finding new pages
  puts "#{e.message}\n\tfrom #{e.backtrace.last}"
end

ビルド・デプロイ用のジョブ(.github/workflows/jekyll.yml)には下記のようなステップを追加しました。

- name: Build with Jekyll
  run: bundle exec jekyll build
    :
- name: Find new pages since previous deploy
  run: ruby ./script/find_new_pages.rb
    :

詳細は https://github.com/zunda/zunda.github.io/blob/master/_posts/2026-01-15-find-new-pages-with-rss.md にメモしてあります。

[neko314]

新しいページのURLをGitHub Actionsのログに記録することができました。

GitHub ActionsのbuildジョブのFind new pages since previous deployのログは下記のようになりました。やったね!!

すごい!!!!

[neko314]

ビルドしたページをJekyllに教えてもらう手順をなかなかみつけられないので、ちょっと脱線してRSSフィードを利用して新しいページを検出してみました。この方法はGitHub Workflowにビルド結果のアーティファクトやキャッシュを保管しておいてもらう必要がない利点がありそうですが、何かの理由でRSSを公開できない場合には使えません。

「公開できない」ではないんですが、今すでにるびまにはRSSがあるので https://github.com/jekyll/jekyll-feed?tab=readme-ov-file#already-have-a-feed-path の方法でプラグインで生成する方は別パスを使うようにした上で、 @zunda さんが検証してくださったアプローチを実際に投入できると良さそうに思いました！

[zunda]

ありがとうございます!! プルリクエスト #642 を作ってみました。

るびまのJekyllの_config.ymlにはプラグインとしてjekyll-feedが含まれていないので、るびまではRSSを公開していないと勘違いしてしまいましたが、実際には、ルートディレクトリにfeed.xmlとしてテンプレートを置いておくだけで、_site/feed.xmlが生成されるのですね。

このプルリクエストでは各号目次が列挙されるfeed.xmlに倣ってそれぞれの記事が列挙されるfeed-articles.xmlを追加して、これに対して差分を検出するスクリプトを書いてみました。

最初のデプロイでは比較対象のRSSが公開されていないためスクリプトは404エラーをもらいますが、スクリプトそのものとしては正常終了するようにしてあります。

[zunda]

新しい記事が公開されたので利用手順をまとめました。後日、doc/editing_process.md へのプルリクエストとしてまとめようと思います。

---

1. masterブランチへのpush (mergeをきっかけとしたものも含む) をきっかけとして実行されたワークフローの一覧から記事を公開したプルリクエストに対応したものを見つける
2. 対象の「Merge pull request …」という表題をクリックする
3. 「build」ジョブと「deploy」ジョブのうち「build」をクリックする
4. 「Show new pages since previous deploy」ステップをクリックする

ことによって、下記のような情報が表示されます。表示されたURLをクリックすることでデプロイされた記事を確認することもできます。

Show new pages since previous deploy
1 ▸ Run bundle exec ruby script/show_new_pages.rb
6 New pages:
7 https://magazine.rubyist.net/articles/ ...

今回のpushで複数の記事が新しく公開された場合は複数のURLが表示されます。

このワークフローの現状の詳細は/.github/workflows/jekyll.ymlで、実行されるスクリプトはscript/show_new_pages.rbで確認できます。

[zunda]

#653 で文書化の作業を続けていきます。